List records

v1.0.0

Lists people, company or other records, with the option to filter and sort results.

Required scopes: record_permission:read, object_configuration:read.

Input

{
  "type": "object",
  "properties": {
    "filter": {
      "type": "object",
      "description": "An object used to filter results to a subset of results. Cannot be used together with `filter_view_id`. See the [full guide to filtering and sorting here](/rest-api/guides/filtering-and-sorting)."
    },
    "filter_view_id": {
      "type": "string",
      "format": "uuid",
      "description": "UUID of a saved view on this object or list. When set, results are filtered using that view's filter configuration. Cannot be used together with `filter`. Note: sorts, limits, and offsets are applied independently and are not taken from the view. All attributes are returned regardless of which attributes are visible in the view."
    },
    "limit": {
      "type": "number",
      "description": "The maximum number of results to return. Defaults to 500. See the [full guide to pagination here](/rest-api/guides/pagination)."
    },
    "object": {
      "type": "string",
      "description": "A UUID or slug to identify the object to list records for."
    },
    "offset": {
      "type": "number",
      "description": "The number of results to skip over before returning. Defaults to 0. See the [full guide to pagination here](/rest-api/guides/pagination)."
    },
    "sorts": {
      "type": "array",
      "description": "An object used to sort results. See the [full guide to filtering and sorting here](/rest-api/guides/filtering-and-sorting).",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "object"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "created_at",
          "web_url",
          "values"
        ],
        "properties": {
          "created_at": {
            "type": "string",
            "description": "When this record was created."
          },
          "id": {
            "type": "object",
            "required": [
              "workspace_id",
              "object_id",
              "record_id"
            ],
            "properties": {
              "object_id": {
                "type": "string",
                "format": "uuid",
                "description": "A UUID identifying the object this record belongs to."
              },
              "record_id": {
                "type": "string",
                "format": "uuid",
                "description": "A UUID identifying this record."
              },
              "workspace_id": {
                "type": "string",
                "format": "uuid",
                "description": "A UUID identifying the workspace this record belongs to."
              }
            }
          },
          "values": {
            "type": "object",
            "description": "A record type with an attribute `api_slug` as the key, and an array of value objects as the values."
          },
          "web_url": {
            "type": "string",
            "format": "uri",
            "description": "A URL that links directly to the record page in the Attio web application."
          }
        }
      }
    }
  }
}