> For the complete documentation index, see [llms.txt](https://docs.zenlytic.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zenlytic.com/developers/models.md).

# Models

## The ApiV2CollectionResponse\_CredentialSummarySchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2CollectionResponse_CredentialSummarySchema_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CredentialSummarySchema"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2CollectionResponse[CredentialSummarySchema]"},"CredentialSummarySchema":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"workspace_id":{"type":"string","title":"Workspace Id"},"workspace_name":{"type":"string","title":"Workspace Name"}},"type":"object","required":["id","name","type","workspace_id","workspace_name"],"title":"CredentialSummarySchema"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2CollectionResponse\_GroupResponseSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2CollectionResponse_GroupResponseSchema_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupResponseSchema"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2CollectionResponse[GroupResponseSchema]"},"GroupResponseSchema":{"properties":{"id":{"type":"string","title":"Id"},"workspace_id":{"type":"string","title":"Workspace Id"},"name":{"type":"string","title":"Name"},"user_attribute_precedence":{"type":"integer","title":"User Attribute Precedence"},"users":{"items":{"type":"string"},"type":"array","title":"Users"}},"type":"object","required":["id","workspace_id","name","user_attribute_precedence","users"],"title":"GroupResponseSchema"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2CollectionResponse\_OrgAdminSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2CollectionResponse_OrgAdminSchema_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrgAdminSchema"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2CollectionResponse[OrgAdminSchema]"},"OrgAdminSchema":{"properties":{"user_id":{"type":"string","title":"User Id"},"email":{"type":"string","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"}},"type":"object","required":["user_id","email"],"title":"OrgAdminSchema"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2CollectionResponse\_UserAttributeDefinitionSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2CollectionResponse_UserAttributeDefinitionSchema_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UserAttributeDefinitionSchema"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2CollectionResponse[UserAttributeDefinitionSchema]"},"UserAttributeDefinitionSchema":{"properties":{"id":{"type":"string","title":"Id"},"workspace_id":{"type":"string","title":"Workspace Id"},"name":{"type":"string","title":"Name"},"data_type":{"$ref":"#/components/schemas/UserAttributeDataType"},"label":{"type":"string","title":"Label"}},"type":"object","required":["id","workspace_id","name","data_type","label"],"title":"UserAttributeDefinitionSchema"},"UserAttributeDataType":{"type":"string","enum":["string","number","date"],"title":"UserAttributeDataType"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2CollectionResponse\_UserAttributeSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2CollectionResponse_UserAttributeSchema_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UserAttributeSchema"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2CollectionResponse[UserAttributeSchema]"},"UserAttributeSchema":{"properties":{"id":{"type":"string","title":"Id"},"user_attribute_definition_id":{"type":"string","title":"User Attribute Definition Id"},"value":{"type":"string","title":"Value"},"data_type":{"$ref":"#/components/schemas/UserAttributeDataType"},"name":{"type":"string","title":"Name"},"source":{"$ref":"#/components/schemas/UserAttributeSource"},"source_id":{"type":"string","title":"Source Id"},"user_attribute_precedence":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Attribute Precedence"},"is_overridden":{"type":"boolean","title":"Is Overridden"}},"type":"object","required":["id","user_attribute_definition_id","value","data_type","name","source","source_id","user_attribute_precedence","is_overridden"],"title":"UserAttributeSchema"},"UserAttributeDataType":{"type":"string","enum":["string","number","date"],"title":"UserAttributeDataType"},"UserAttributeSource":{"type":"string","enum":["user","group"],"title":"UserAttributeSource"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2ErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2ErrorResponse":{"properties":{"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["meta"],"title":"ApiV2ErrorResponse"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2Response\_CopyCredentialsResponseSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2Response_CopyCredentialsResponseSchema_":{"properties":{"data":{"$ref":"#/components/schemas/CopyCredentialsResponseSchema"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2Response[CopyCredentialsResponseSchema]"},"CopyCredentialsResponseSchema":{"properties":{"new_credential_ids":{"items":{"type":"string"},"type":"array","title":"New Credential Ids"}},"type":"object","required":["new_credential_ids"],"title":"CopyCredentialsResponseSchema"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2Response\_CreateWorkspaceResponseSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2Response_CreateWorkspaceResponseSchema_":{"properties":{"data":{"$ref":"#/components/schemas/CreateWorkspaceResponseSchema"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2Response[CreateWorkspaceResponseSchema]"},"CreateWorkspaceResponseSchema":{"properties":{"id":{"type":"string","title":"Id"},"shop_name":{"type":"string","title":"Shop Name"},"provision_by_default":{"type":"boolean","title":"Provision By Default"}},"type":"object","required":["id","shop_name","provision_by_default"],"title":"CreateWorkspaceResponseSchema"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2Response\_GroupResponseSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2Response_GroupResponseSchema_":{"properties":{"data":{"$ref":"#/components/schemas/GroupResponseSchema"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2Response[GroupResponseSchema]"},"GroupResponseSchema":{"properties":{"id":{"type":"string","title":"Id"},"workspace_id":{"type":"string","title":"Workspace Id"},"name":{"type":"string","title":"Name"},"user_attribute_precedence":{"type":"integer","title":"User Attribute Precedence"},"users":{"items":{"type":"string"},"type":"array","title":"Users"}},"type":"object","required":["id","workspace_id","name","user_attribute_precedence","users"],"title":"GroupResponseSchema"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2Response\_UserAttributeDefinitionSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2Response_UserAttributeDefinitionSchema_":{"properties":{"data":{"$ref":"#/components/schemas/UserAttributeDefinitionSchema"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2Response[UserAttributeDefinitionSchema]"},"UserAttributeDefinitionSchema":{"properties":{"id":{"type":"string","title":"Id"},"workspace_id":{"type":"string","title":"Workspace Id"},"name":{"type":"string","title":"Name"},"data_type":{"$ref":"#/components/schemas/UserAttributeDataType"},"label":{"type":"string","title":"Label"}},"type":"object","required":["id","workspace_id","name","data_type","label"],"title":"UserAttributeDefinitionSchema"},"UserAttributeDataType":{"type":"string","enum":["string","number","date"],"title":"UserAttributeDataType"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2Response\_UserAttributeSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2Response_UserAttributeSchema_":{"properties":{"data":{"$ref":"#/components/schemas/UserAttributeSchema"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2Response[UserAttributeSchema]"},"UserAttributeSchema":{"properties":{"id":{"type":"string","title":"Id"},"user_attribute_definition_id":{"type":"string","title":"User Attribute Definition Id"},"value":{"type":"string","title":"Value"},"data_type":{"$ref":"#/components/schemas/UserAttributeDataType"},"name":{"type":"string","title":"Name"},"source":{"$ref":"#/components/schemas/UserAttributeSource"},"source_id":{"type":"string","title":"Source Id"},"user_attribute_precedence":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Attribute Precedence"},"is_overridden":{"type":"boolean","title":"Is Overridden"}},"type":"object","required":["id","user_attribute_definition_id","value","data_type","name","source","source_id","user_attribute_precedence","is_overridden"],"title":"UserAttributeSchema"},"UserAttributeDataType":{"type":"string","enum":["string","number","date"],"title":"UserAttributeDataType"},"UserAttributeSource":{"type":"string","enum":["user","group"],"title":"UserAttributeSource"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The ApiV2Response\_WorkspaceManagerOrgSchema\_ object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ApiV2Response_WorkspaceManagerOrgSchema_":{"properties":{"data":{"$ref":"#/components/schemas/WorkspaceManagerOrgSchema"},"meta":{"$ref":"#/components/schemas/MetaSchema"}},"type":"object","required":["data","meta"],"title":"ApiV2Response[WorkspaceManagerOrgSchema]"},"WorkspaceManagerOrgSchema":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"require_sso":{"type":"boolean","title":"Require Sso","default":false},"workspaces":{"items":{"$ref":"#/components/schemas/WorkspaceManagerWorkspaceSchema"},"type":"array","title":"Workspaces"}},"type":"object","required":["id","name","workspaces"],"title":"WorkspaceManagerOrgSchema"},"WorkspaceManagerWorkspaceSchema":{"properties":{"id":{"type":"string","title":"Id"},"shop_name":{"type":"string","title":"Shop Name"},"provision_by_default":{"type":"boolean","title":"Provision By Default"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","shop_name","provision_by_default"],"title":"WorkspaceManagerWorkspaceSchema"},"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The CopyCredentialsResponseSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CopyCredentialsResponseSchema":{"properties":{"new_credential_ids":{"items":{"type":"string"},"type":"array","title":"New Credential Ids"}},"type":"object","required":["new_credential_ids"],"title":"CopyCredentialsResponseSchema"}}}}
```

## The CopyCredentialsSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CopyCredentialsSchema":{"properties":{"credential_ids":{"items":{"type":"string"},"type":"array","title":"Credential Ids"}},"type":"object","required":["credential_ids"],"title":"CopyCredentialsSchema"}}}}
```

## The CreateGroupSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CreateGroupSchema":{"properties":{"name":{"type":"string","title":"Name"},"user_attribute_precedence":{"type":"integer","title":"User Attribute Precedence"}},"type":"object","required":["name","user_attribute_precedence"],"title":"CreateGroupSchema"}}}}
```

## The CreateUserAttributeDefinitionSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CreateUserAttributeDefinitionSchema":{"properties":{"name":{"type":"string","title":"Name"},"data_type":{"$ref":"#/components/schemas/UserAttributeDataType"},"label":{"type":"string","title":"Label"}},"type":"object","required":["name","data_type","label"],"title":"CreateUserAttributeDefinitionSchema"},"UserAttributeDataType":{"type":"string","enum":["string","number","date"],"title":"UserAttributeDataType"}}}}
```

## The CreateUserAttributeSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CreateUserAttributeSchema":{"properties":{"user_attribute_definition_id":{"type":"string","title":"User Attribute Definition Id"},"value":{"type":"string","title":"Value"}},"type":"object","required":["user_attribute_definition_id","value"],"title":"CreateUserAttributeSchema"}}}}
```

## The CreateWorkspaceResponseSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CreateWorkspaceResponseSchema":{"properties":{"id":{"type":"string","title":"Id"},"shop_name":{"type":"string","title":"Shop Name"},"provision_by_default":{"type":"boolean","title":"Provision By Default"}},"type":"object","required":["id","shop_name","provision_by_default"],"title":"CreateWorkspaceResponseSchema"}}}}
```

## The CreateWorkspaceSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CreateWorkspaceSchema":{"properties":{"name":{"type":"string","title":"Name"},"provision_by_default":{"type":"boolean","title":"Provision By Default","default":false}},"type":"object","required":["name"],"title":"CreateWorkspaceSchema"}}}}
```

## The CredentialSummarySchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"CredentialSummarySchema":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"workspace_id":{"type":"string","title":"Workspace Id"},"workspace_name":{"type":"string","title":"Workspace Name"}},"type":"object","required":["id","name","type","workspace_id","workspace_name"],"title":"CredentialSummarySchema"}}}}
```

## The DeleteWorkspaceSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"DeleteWorkspaceSchema":{"properties":{"confirmation_name":{"type":"string","title":"Confirmation Name"}},"type":"object","required":["confirmation_name"],"title":"DeleteWorkspaceSchema"}}}}
```

## The DemoteOrgAdminSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"DemoteOrgAdminSchema":{"properties":{"user_id":{"type":"string","title":"User Id"},"new_role":{"type":"string","title":"New Role"}},"type":"object","required":["user_id","new_role"],"title":"DemoteOrgAdminSchema"}}}}
```

## The ErrorSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"}}}}
```

## The FieldAlreadyExistsErrorMetadata object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"}}}}
```

## The GroupResponseSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"GroupResponseSchema":{"properties":{"id":{"type":"string","title":"Id"},"workspace_id":{"type":"string","title":"Workspace Id"},"name":{"type":"string","title":"Name"},"user_attribute_precedence":{"type":"integer","title":"User Attribute Precedence"},"users":{"items":{"type":"string"},"type":"array","title":"Users"}},"type":"object","required":["id","workspace_id","name","user_attribute_precedence","users"],"title":"GroupResponseSchema"}}}}
```

## The MetaSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"MetaSchema":{"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"errors":{"items":{"$ref":"#/components/schemas/ErrorSchema"},"type":"array","title":"Errors"},"warnings":{"items":{"$ref":"#/components/schemas/WarningSchema"},"type":"array","title":"Warnings"},"request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Source"}},"type":"object","required":["status"],"title":"MetaSchema"},"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"},"ErrorSchema":{"properties":{"message":{"type":"string","title":"Message"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred At"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_metadata":{"anyOf":[{"$ref":"#/components/schemas/FieldAlreadyExistsErrorMetadata"},{"type":"null"}]}},"type":"object","required":["message"],"title":"ErrorSchema"},"FieldAlreadyExistsErrorMetadata":{"properties":{"existing_column_ids":{"items":{"type":"string"},"type":"array","title":"Existing Column Ids"}},"type":"object","required":["existing_column_ids"],"title":"FieldAlreadyExistsErrorMetadata"},"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The OrgAdminSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"OrgAdminSchema":{"properties":{"user_id":{"type":"string","title":"User Id"},"email":{"type":"string","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"}},"type":"object","required":["user_id","email"],"title":"OrgAdminSchema"}}}}
```

## The ResponseStatus object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"ResponseStatus":{"type":"string","enum":["success","error"],"title":"ResponseStatus"}}}}
```

## The UpdateGroupSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UpdateGroupSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"user_attribute_precedence":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Attribute Precedence"}},"type":"object","title":"UpdateGroupSchema"}}}}
```

## The UpdateProvisioningSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UpdateProvisioningSchema":{"properties":{"provision_by_default":{"type":"boolean","title":"Provision By Default"}},"type":"object","required":["provision_by_default"],"title":"UpdateProvisioningSchema"}}}}
```

## The UpdateRequireSsoSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UpdateRequireSsoSchema":{"properties":{"require_sso":{"type":"boolean","title":"Require Sso"}},"type":"object","required":["require_sso"],"title":"UpdateRequireSsoSchema"}}}}
```

## The UpdateUserAttributeDefinitionSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UpdateUserAttributeDefinitionSchema":{"properties":{"label":{"type":"string","title":"Label"}},"type":"object","required":["label"],"title":"UpdateUserAttributeDefinitionSchema"}}}}
```

## The UpdateUserAttributeSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UpdateUserAttributeSchema":{"properties":{"value":{"type":"string","title":"Value"}},"type":"object","required":["value"],"title":"UpdateUserAttributeSchema"}}}}
```

## The UserAttributeDataType object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UserAttributeDataType":{"type":"string","enum":["string","number","date"],"title":"UserAttributeDataType"}}}}
```

## The UserAttributeDefinitionSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UserAttributeDefinitionSchema":{"properties":{"id":{"type":"string","title":"Id"},"workspace_id":{"type":"string","title":"Workspace Id"},"name":{"type":"string","title":"Name"},"data_type":{"$ref":"#/components/schemas/UserAttributeDataType"},"label":{"type":"string","title":"Label"}},"type":"object","required":["id","workspace_id","name","data_type","label"],"title":"UserAttributeDefinitionSchema"},"UserAttributeDataType":{"type":"string","enum":["string","number","date"],"title":"UserAttributeDataType"}}}}
```

## The UserAttributeSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UserAttributeSchema":{"properties":{"id":{"type":"string","title":"Id"},"user_attribute_definition_id":{"type":"string","title":"User Attribute Definition Id"},"value":{"type":"string","title":"Value"},"data_type":{"$ref":"#/components/schemas/UserAttributeDataType"},"name":{"type":"string","title":"Name"},"source":{"$ref":"#/components/schemas/UserAttributeSource"},"source_id":{"type":"string","title":"Source Id"},"user_attribute_precedence":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Attribute Precedence"},"is_overridden":{"type":"boolean","title":"Is Overridden"}},"type":"object","required":["id","user_attribute_definition_id","value","data_type","name","source","source_id","user_attribute_precedence","is_overridden"],"title":"UserAttributeSchema"},"UserAttributeDataType":{"type":"string","enum":["string","number","date"],"title":"UserAttributeDataType"},"UserAttributeSource":{"type":"string","enum":["user","group"],"title":"UserAttributeSource"}}}}
```

## The UserAttributeSource object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"UserAttributeSource":{"type":"string","enum":["user","group"],"title":"UserAttributeSource"}}}}
```

## The WarningSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"WarningSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"WarningSchema"}}}}
```

## The WorkspaceManagerOrgSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"WorkspaceManagerOrgSchema":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"require_sso":{"type":"boolean","title":"Require Sso","default":false},"workspaces":{"items":{"$ref":"#/components/schemas/WorkspaceManagerWorkspaceSchema"},"type":"array","title":"Workspaces"}},"type":"object","required":["id","name","workspaces"],"title":"WorkspaceManagerOrgSchema"},"WorkspaceManagerWorkspaceSchema":{"properties":{"id":{"type":"string","title":"Id"},"shop_name":{"type":"string","title":"Shop Name"},"provision_by_default":{"type":"boolean","title":"Provision By Default"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","shop_name","provision_by_default"],"title":"WorkspaceManagerWorkspaceSchema"}}}}
```

## The WorkspaceManagerWorkspaceSchema object

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"components":{"schemas":{"WorkspaceManagerWorkspaceSchema":{"properties":{"id":{"type":"string","title":"Id"},"shop_name":{"type":"string","title":"Shop Name"},"provision_by_default":{"type":"boolean","title":"Provision By Default"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","shop_name","provision_by_default"],"title":"WorkspaceManagerWorkspaceSchema"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.zenlytic.com/developers/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.