> ## Documentation Index > Fetch the complete documentation index at: https://docs.attio.com/llms.txt > Use this file to discover all available pages before exploring further. # Create an object view > Creates a view of an object with a filter, sorts, shown attributes and kanban settings. Attributes, objects, options and statuses can be referenced by slug, ID or title; the response references them by ID, as the get view endpoint does. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. Required scopes: `view:read-write`, `object_configuration:read`. Supported token levels: `workspace`, `user`. ## OpenAPI ````yaml https://api.attio.com/openapi/api post /v2/objects/{object}/views openapi: 3.1.0 info: title: Attio API version: 2.0.0 contact: name: Attio Support email: support@attio.com url: https://attio.com/help servers: - url: https://api.attio.com description: Production security: - oauth2: [] tags: - name: Objects description: >- Objects are the core data models inside of Attio. They contain standard objects, such as [people](/rest-api/endpoint-reference/standard-objects/people/list-person-records), [companies](/rest-api/endpoint-reference/standard-objects/companies/list-company-records) or [deals](/docs/standard-objects-deals), and custom objects that are specific to your use-case. See our [objects and lists guide](/docs/objects-and-lists) for more information. - name: Activities description: >- Activities model event-based data that can be logged against a record, for example a phone call. Each activity extends a schema, which supplies the attributes that every activity of that kind shares. - name: Views description: Views are saved table or board layouts for an object or a list. - name: Attributes description: >- Attributes model properties of objects, lists and activities. Some attributes, such as the `name` attribute on a person, are system-defined, while others are user-defined. Attributes are one of [many types](/docs/attribute-types) such as text, location or select. See our [objects and lists guide](/docs/objects-and-lists) for more information. - name: Records description: >- Records are individual instances of objects e.g. a specific [person](/rest-api/endpoint-reference/standard-objects/people/list-person-records) or [company](/rest-api/endpoint-reference/standard-objects/companies/list-company-records). See our [objects and lists guide](/docs/objects-and-lists) for more information. - name: Activity records description: >- Activity records are individual instances of activities, for example one specific phone call. - name: SCIM groups description: >- SCIM groups represent Attio teams managed through the SCIM provisioning protocol. - name: SCIM schemas description: >- SCIM schemas describe the resource types supported by the SCIM service provider. - name: SCIM users description: >- SCIM users represent workspace members managed through the SCIM provisioning protocol. - name: Lists description: >- Lists are used to model a particular process. A list contains many records of a single object type, where each record is represented by an entry. Entries contain their own data from attributes defined on the list and also data from their parent record. See our [objects and lists guide](/docs/objects-and-lists) for more information. - name: Meta description: Meta endpoints are used to get information about the API token. - name: Entries description: >- Entries are elements in a list that reference a single parent record. Entries contain their own data from attributes defined on the list and also data from their parent record. See our [objects and lists guide](/docs/objects-and-lists) for more information. - name: Files description: >- Files are documents and folders linked to records, stored either in Attio or connected via external storage providers. - name: Workspace members description: >- Workspace members represent a user with access to a workspace. Workspace members are assigned roles that determine what they can do within the workspace. - name: Notes description: Notes are rich text documents that reference a single parent record. - name: Meetings description: >- Meetings are events synced from your calendar, added manually or added from third-party integrations. - name: Emails description: Emails are messages synced from connected mailboxes. - name: Sequences description: Sequences are automated email campaigns sent from Attio. - name: Workspace blocklist description: >- An address is an email address (jane@acme.com) or a domain (acme.com). The workspace blocklist is the workspace-wide list of addresses whose emails and calendar events are hidden in Attio. An email address matches only itself, and a domain matches every email address at that domain. The address itself is the key: there is no separate ID. - name: Call recordings description: >- Call recordings store video, audio, transcript and speaker information for calls. They are linked to meetings. - name: Transcripts description: >- Transcripts contain the speech segments and speaker information for a call recording. They are linked to call recordings. - name: Tasks description: >- A task is a defined, actionable item with references to linked records and assigned workspace members. - name: Webhooks description: >- Webhooks allow you to listen for changes to data in Attio, for example when a record is updated. - name: Threads description: >- Threads are groups of [comments](/rest-api/endpoint-reference/comments/get-a-comment) on either a record or entry. - name: Comments description: >- Comments are messages on a [thread](/rest-api/endpoint-reference/threads/list-threads). - name: People description: >- People are one of the core objects inside of Attio. Person records can be added to lists and can be created automatically when syncing your mailbox. - name: Companies description: >- Companies are one of the core objects inside of Attio. Company records can be added to lists and can be created automatically when syncing your mailbox. - name: Users description: >- Users are an optional standard object that represents a user of your system. Users can belong to many workspaces. - name: Deals description: >- Deals are an optional standard object that represent a deal or opportunity. - name: Workspaces description: >- Workspaces are an optional standard object that represent a workspace or account in your system. Workspaces have many users and can be used to model a multi-tenant system. A company record can optionally have multiple workspaces. - name: SQL description: >- Query records and list entries across your workspace using SQL. A single query can reference any object or list in the workspace. paths: /v2/objects/{object}/views: post: tags: - Views summary: Create an object view description: >- Creates a view of an object with a filter, sorts, shown attributes and kanban settings. Attributes, objects, options and statuses can be referenced by slug, ID or title; the response references them by ID, as the get view endpoint does. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. Required scopes: `view:read-write`, `object_configuration:read`. Supported token levels: `workspace`, `user`. parameters: - schema: type: string description: A UUID or slug to identify the object. example: people required: true name: object in: path requestBody: required: true content: application/json: schema: type: object properties: data: type: object properties: title: type: string minLength: 1 description: The title of the view. example: Leads type: type: string enum: - table - kanban description: How the view shows records. example: table filter: description: >- The filter of the view. Omitted or `null` to show all records. oneOf: - $ref: '#/components/schemas/view-filter' - type: 'null' sorts: type: array description: The sorts, in order. Omitted for no sorts. items: $ref: '#/components/schemas/view-sort' maxItems: 5 attributes: type: array description: >- The attributes that the view shows, in display order. Omitted for no attributes, as a new view in the app has. items: $ref: '#/components/schemas/view-attribute' maxItems: 100 kanban: type: object description: >- The settings of a kanban view. Required for kanban views and not allowed for table views. properties: status_attribute: $ref: '#/components/schemas/view-attribute-path' description: >- The status attribute whose statuses are the columns of the board, on the view's object or on the parent record of a list entry. show_no_status_column: type: boolean description: >- Whether the board shows a column for the records that have no status. If omitted, the setting of a new kanban view in the app is used: `true`, `icon` and `null`. attribute_label_display: type: string enum: - icon - text description: >- How the cards label the attributes that they show: with the attribute icon or with the attribute title. If omitted, the setting of a new kanban view in the app is used: `true`, `icon` and `null`. aggregation: oneOf: - $ref: '#/components/schemas/view-kanban-aggregation' - type: 'null' description: >- The calculation that the footer of each column of the board shows. `null` when the board has none. If omitted, the setting of a new kanban view in the app is used: `true`, `icon` and `null`. additionalProperties: false required: - status_attribute required: - title - type required: - data responses: '200': description: Success content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/object-view-with-definition' required: - data description: Success '400': description: Bad Request content: application/json: schema: type: object properties: status_code: type: number enum: - 400 type: type: string enum: - invalid_request_error code: type: string example: unknown_attribute message: type: string example: No attribute matches "nickname" on this object path: type: array items: anyOf: - type: string - type: number example: - data - filter - attribute required: - status_code - type - code - message - path description: Bad Request '403': description: Forbidden content: application/json: schema: type: object properties: status_code: type: number enum: - 403 type: type: string enum: - auth_error code: type: string enum: - unauthorized message: type: string example: >- You do not have the necessary permissions to create views of this object. required: - status_code - type - code - message description: Forbidden '404': description: Not Found content: application/json: schema: type: object properties: status_code: type: number enum: - 404 type: type: string enum: - invalid_request_error code: type: string enum: - not_found message: type: string example: The referenced object was not found. required: - status_code - type - code - message description: Not Found security: - oauth2: - view:read-write - object_configuration:read components: schemas: view-filter: description: >- A condition, or a group of filters of which all (`and`) or at least one (`or`) must match. oneOf: - $ref: '#/components/schemas/view-filter-condition' - title: All of (and) type: object properties: and: type: array minItems: 1 items: $ref: '#/components/schemas/view-filter' required: - and additionalProperties: false example: and: - attribute: name op: contains value: Ada - attribute: stage op: eq value: Lead - title: Any of (or) type: object properties: or: type: array minItems: 1 items: $ref: '#/components/schemas/view-filter' required: - or additionalProperties: false example: or: - attribute: stage op: eq value: Lead - attribute: stage op: empty example: and: - attribute: name op: contains value: Ada - or: - attribute: stage op: eq value: Lead - attribute: stage op: empty view-sort: type: object properties: attribute: $ref: '#/components/schemas/view-attribute-path' field: type: string description: >- The field to sort by. If omitted, the default field of the attribute type is used. A record reference cannot be sorted directly; sort by a path to an attribute of the referenced record. | Attribute type | Fields | | --- | --- | | `text` | `value` (default) | | `number` | `value` (default) | | `checkbox` | `value` (default) | | `date` | `value` (default) | | `timestamp` | `value` (default) | | `rating` | `value` (default) | | `currency` | `currency_value` (default) | | `select` | `option` (default) | | `status` | `status` (default), `active_from` | | `personal-name` | `first_name`, `last_name`, `full_name` (default) | | `location` | `locality`, `region`, `country_code` | | `domain` | `domain` (default) | | `email-address` | `email_address` (default) | | `phone-number` | `phone_number` (default) | | `actor-reference` | `referenced_actor_id` (default) | | `interaction` | `interacted_at` (default), `owner_member_id` | example: last_name direction: type: string enum: - asc - desc example: asc required: - attribute - direction description: A sort on one attribute. example: attribute: name field: last_name direction: asc view-attribute: type: object properties: attribute: $ref: '#/components/schemas/view-attribute-path' field: type: string description: The field of the attribute that the column shows. example: first_name title: type: string description: >- The column title. If omitted, the column shows the title of the attribute. example: Employer aggregation: type: - string - 'null' enum: - count_empty - count_not_empty - percent_empty - percent_not_empty - sum - mean - max - min description: >- The calculation that the column footer of a table view shows, on the field that the column shows. Omitted when the column has none. Not allowed on a kanban view, which uses `kanban.aggregation`. In an update, an omitted aggregation keeps the aggregation of a column with the same attribute and field, and `null` removes it. Each field can count and give the percentage of records where it is empty or not empty. `sum`, `mean`, `min` and `max` are only for number, currency and rating attributes. example: sum required: - attribute description: An attribute that the view shows. example: attribute: name field: first_name view-attribute-path: anyOf: - type: string - type: array prefixItems: - type: string description: A slug or ID of an attribute of the view's object. items: $ref: '#/components/schemas/view-object-attribute-ref' minItems: 2 maxItems: 5 description: >- A slug or ID of an attribute of the view's object, or an array that follows record references. The array starts with a slug or ID of an attribute of the view's object. Each later item is an `{object, attribute}` pair. Use a slug or ID, not an array, for a single attribute. Responses use IDs only. example: - company - object: companies attribute: name view-kanban-aggregation: type: object properties: attribute: $ref: '#/components/schemas/view-attribute-path' field: type: string description: >- The field to aggregate. If omitted, the default field of the attribute type is used. Location and interaction attributes need a field. example: currency_value type: type: string enum: - count_empty - count_not_empty - percent_empty - percent_not_empty - sum - mean - max - min description: >- The calculation. Each field can count and give the percentage of records where it is empty or not empty. `sum`, `mean`, `min` and `max` are only for number, currency and rating attributes. example: sum required: - attribute - type description: >- The calculation that the footer of each column of the board shows. `null` when the board has none. example: attribute: deal_value type: sum object-view-with-definition: allOf: - $ref: '#/components/schemas/object-view' - type: object properties: type: type: string enum: - table - kanban description: How the view shows records. example: table filter: allOf: - $ref: '#/components/schemas/view-filter' - description: >- The filter of the view. `null` when the view shows all records. sorts: type: array items: $ref: '#/components/schemas/view-sort' description: The sorts, in order. attributes: type: array items: $ref: '#/components/schemas/view-attribute' description: The attributes that the view shows, in display order. kanban: type: object properties: status_attribute: allOf: - $ref: '#/components/schemas/view-attribute-path' - anyOf: - type: string - type: array prefixItems: - type: string description: >- A slug or ID of an attribute of the view's object. items: $ref: '#/components/schemas/view-object-attribute-ref' minItems: 2 maxItems: 5 - type: 'null' description: >- The status attribute whose statuses are the columns of the board, on the view's object or on the parent record of a list entry. `null` when none is set yet. show_no_status_column: type: boolean description: >- Whether the board shows a column for the records that have no status. example: true attribute_label_display: type: string enum: - icon - text description: >- How the cards label the attributes that they show: with the attribute icon or with the attribute title. example: icon aggregation: allOf: - $ref: '#/components/schemas/view-kanban-aggregation' - type: - object - 'null' required: - status_attribute - show_no_status_column - attribute_label_display - aggregation description: The settings of a kanban view. Omitted for table views. metadata: type: object additionalProperties: type: object properties: kind: type: string enum: - attribute - object - option - status - team title: type: string api_slug: type: - string - 'null' required: - kind - title - api_slug description: >- The title and slug of each attribute and object ID in the view, and the title of each option, status and team ID in the filter values. The view only uses IDs, so that it does not change when a slug changes. example: 41252299-f8c7-4b5e-99c9-4ff8321d2f96: kind: attribute title: Name api_slug: name required: - type - sorts - attributes - metadata view-filter-condition: type: object properties: attribute: $ref: '#/components/schemas/view-attribute-path' field: type: string description: >- The field of the attribute. If omitted, the default field of the attribute type is used. example: last_name op: type: string enum: - eq - not_eq - lt - gt - contains - not_contains - starts_with - ends_with - empty - not_empty - entered - not_entered - in description: >- The operator. `in` takes a non-empty array and matches when one `eq` condition with one of its values matches. Responses never contain `in`. example: contains value: description: >- The value. Its shape depends on the attribute type, the field and the operator: | Attribute type | Field | Operators | Value | | --- | --- | --- | --- | | `text` | `value` (default) | `eq`, `not_eq`, `contains`, `not_contains`, `starts_with`, `ends_with` | A non-empty string | | `text` | `value` (default) | `empty`, `not_empty` | No value | | `number` | `value` (default) | `eq`, `not_eq`, `lt`, `gt` | A number | | `number` | `value` (default) | `empty`, `not_empty` | No value | | `rating` | `value` (default) | `eq`, `not_eq`, `lt`, `gt` | A number | | `rating` | `value` (default) | `empty`, `not_empty` | No value | | `checkbox` | `value` (default) | `eq` | `true` or `false` | | `select` | `option` (default) | `eq`, `not_eq`, `lt`, `gt` | A select option ID or title | | `select` | `option` (default) | `empty`, `not_empty` | No value | | `status` | `status` (default) | `eq`, `not_eq` | A status ID or title | | `status` | `status` (default) | `entered`, `not_entered` | `{"status": }` with exactly one of `after` or `before`, each an ISO 8601 timestamp or `{"relative": }` with one unit of years, months, weeks, days, hours, minutes or seconds, e.g. `-PT12H` | | `status` | `status` (default) | `empty`, `not_empty` | No value | | `actor-reference` | `referenced_actor_id` (default) | `eq`, `not_eq` | A workspace member ID, or `{"current_member": true}` | | `actor-reference` | `referenced_actor_id` (default) | `empty`, `not_empty` | No value | | `actor-reference` | `referenced_actor_type` | `eq`, `not_eq` | An actor type, such as `workspace-member` or `api-token` | | `actor-reference` | `referenced_actor_team_id` | `eq`, `not_eq` | A team ID | | `currency` | `currency_value` (default) | `eq`, `not_eq`, `lt`, `gt` | A number | | `currency` | `currency_value` (default) | `empty`, `not_empty` | No value | | `date` | `value` (default) | `eq`, `not_eq` | A date in the format `YYYY-MM-DD` | | `date` | `value` (default) | `lt`, `gt` | A date in the format `YYYY-MM-DD`, or `{"relative": }` with one unit of years, months, weeks or days, e.g. `-P30D` | | `date` | `value` (default) | `empty`, `not_empty` | No value | | `timestamp` | `value` (default) | `eq`, `not_eq` | An ISO 8601 timestamp | | `timestamp` | `value` (default) | `lt`, `gt` | An ISO 8601 timestamp, or `{"relative": }` with one unit of years, months, weeks, days, hours, minutes or seconds, e.g. `-PT12H` | | `timestamp` | `value` (default) | `empty`, `not_empty` | No value | | `record-reference` | `target_record_id` (default) | `eq`, `not_eq` | `{"target_object": , "target_record_id": }` | | `record-reference` | `target_object` | `eq`, `not_eq` | An object slug or ID | | `record-reference` | `target_record_id` (default) | `empty`, `not_empty` | No value | | `interaction` | `interacted_at` (default) | `lt`, `gt` | An ISO 8601 timestamp, or `{"relative": }` with one unit of years, months, weeks, days, hours, minutes or seconds, e.g. `-PT12H` | | `interaction` | `interacted_at` (default) | `empty`, `not_empty` | No value | | `interaction` | `owner_member_id` | `eq`, `not_eq` | A workspace member ID, or `{"current_member": true}` | | `interaction` | `owner_member_id` | `empty`, `not_empty` | No value | | `interaction` | `referenced_actor_team_id` | `eq`, `not_eq` | A team ID | | `location` | `locality` | `eq`, `not_eq`, `contains`, `not_contains`, `starts_with`, `ends_with` | A non-empty string | | `location` | `locality` | `empty`, `not_empty` | No value | | `location` | `region` | `eq`, `not_eq`, `contains`, `not_contains` | A non-empty string | | `location` | `region` | `empty`, `not_empty` | No value | | `location` | `postcode` | `eq`, `not_eq`, `contains`, `not_contains` | A non-empty string | | `location` | `postcode` | `empty`, `not_empty` | No value | | `location` | `country_code` | `eq`, `not_eq` | An ISO 3166-1 alpha-2 country code | | `location` | `country_code` | `empty`, `not_empty` | No value | | `domain` | `domain` (default) | `eq`, `not_eq` | A domain or URL, e.g. `example.com` | | `domain` | `domain` (default) | `contains`, `not_contains`, `starts_with`, `ends_with` | A non-empty string | | `domain` | `domain` (default) | `empty`, `not_empty` | No value | | `email-address` | `email_address` (default) | `eq`, `not_eq`, `contains`, `not_contains`, `starts_with`, `ends_with` | A non-empty string | | `email-address` | `email_address` (default) | `empty`, `not_empty` | No value | | `email-address` | `email_domain` | `eq`, `not_eq`, `contains`, `not_contains` | A non-empty string | | `phone-number` | `phone_number` (default) | `eq`, `not_eq`, `contains`, `not_contains`, `starts_with`, `ends_with` | A non-empty string | | `phone-number` | `phone_number` (default) | `empty`, `not_empty` | No value | | `phone-number` | `country_code` | `eq`, `not_eq` | An ISO 3166-1 alpha-2 country code | | `phone-number` | `country_code` | `empty`, `not_empty` | No value | | `personal-name` | `full_name` (default) | `eq`, `not_eq`, `contains`, `not_contains`, `starts_with`, `ends_with` | A non-empty string | | `personal-name` | `full_name` (default) | `empty`, `not_empty` | No value | | `personal-name` | `first_name` | `eq`, `not_eq`, `contains`, `not_contains`, `starts_with`, `ends_with` | A non-empty string | | `personal-name` | `first_name` | `empty`, `not_empty` | No value | | `personal-name` | `last_name` | `eq`, `not_eq`, `contains`, `not_contains`, `starts_with`, `ends_with` | A non-empty string | | `personal-name` | `last_name` | `empty`, `not_empty` | No value | required: - attribute - op description: A condition on one attribute. title: Condition example: attribute: name op: contains value: Ada view-object-attribute-ref: type: object properties: object: type: string description: >- A slug or ID of the object that the reference of the previous attribute points to. It is required because a reference can allow several objects. example: companies attribute: type: string description: A slug or ID of an attribute of this object. example: name required: - object - attribute object-view: type: object properties: id: type: object properties: workspace_id: type: string format: uuid description: A UUID identifying the workspace this view belongs to. example: 14beef7a-99f7-4534-a87e-70b564330a4c object_id: type: string format: uuid description: A UUID identifying the object this view belongs to. example: 97052eb9-e65e-443f-a297-f2d9a4a7f795 view_id: type: string format: uuid description: >- A UUID identifying this view. Use this value as `filter_view_id` when listing records. example: cf7aaeb5-7507-4a84-9c26-9d36e34d7b70 required: - workspace_id - object_id - view_id title: type: string description: The title of the view shown in the Attio app. example: All people created_at: type: string description: When the view was created. example: '2022-11-21T13:22:49.061281000Z' required: - id - title - created_at securitySchemes: oauth2: type: oauth2 description: This API uses OAuth 2.0 with the authorization code grant flow. flows: authorizationCode: authorizationUrl: https://app.attio.com/authorize tokenUrl: https://app.attio.com/oauth/token scopes: user_management:read: View workspace members. user_management:read-write: View workspace members. record_permission:read: View, and optionally write, records. record_permission:read-write: View, and optionally write, records. object_configuration:read: >- View, and optionally write, the configuration and attributes of objects. object_configuration:read-write: >- View, and optionally write, the configuration and attributes of objects. list_entry:read: View, and optionally write, the entries in a list. list_entry:read-write: View, and optionally write, the entries in a list. list_configuration:read: >- View, and optionally write, the configuration and attributes of lists. list_configuration:read-write: >- View, and optionally write, the configuration and attributes of lists. public_collection:read: >- View, and optionally write, both the settings and information within public collections. public_collection:read-write: >- View, and optionally write, both the settings and information within public collections. private_collection:read: >- View, and optionally modify, both the settings and information of all collections within the workspace, regardless of their access settings. private_collection:read-write: >- View, and optionally modify, both the settings and information of all collections within the workspace, regardless of their access settings. comment:read: View comments (and threads), and optionally write comments. comment:read-write: View comments (and threads), and optionally write comments. task:read: View, and optionally write, tasks. task:read-write: View, and optionally write, tasks. note:read: View, and optionally write, notes. note:read-write: View, and optionally write, notes. meeting:read: View, and optionally write, meetings. meeting:read-write: View, and optionally write, meetings. call_recording:read: >- View, and optionally write, call recordings, transcripts and speakers for meetings. call_recording:read-write: >- View, and optionally write, call recordings, transcripts and speakers for meetings. webhook:read: View, and optionally manage, webhooks. webhook:read-write: View, and optionally manage, webhooks. file:read: View, and upload files. file:read-write: View, and upload files. email:read: View email metadata. Email content is never exposed. email:read-write: View email metadata. Email content is never exposed. activity_configuration:read: >- View, and optionally write, the configuration and attributes of activities. activity_configuration:read-write: >- View, and optionally write, the configuration and attributes of activities. activity_record:read: View, and optionally write, activity records. activity_record:read-write: View, and optionally write, activity records. sequence_unsubscribe:read: View, and optionally add to, the sequence unsubscribe list. sequence_unsubscribe:read-write: View, and optionally add to, the sequence unsubscribe list. email_calendar_blocklist:read: >- View, and optionally manage, the addresses (email addresses and domains) whose emails and calendar events are hidden in Attio. email_calendar_blocklist:read-write: >- View, and optionally manage, the addresses (email addresses and domains) whose emails and calendar events are hidden in Attio. view:read: >- View, and optionally manage, the saved views of objects and lists, with their filters, sorts and shown attributes. view:read-write: >- View, and optionally manage, the saved views of objects and lists, with their filters, sorts and shown attributes. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.