List deal records

POST

objects

deals

records

query

curl --request POST \
  --url https://api.attio.com/v2/objects/deals/records/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {
    "$and": [
      {
        "path": [
          [
            "deals",
            "associated_company"
          ],
          [
            "companies",
            "domains"
          ]
        ],
        "constraints": {
          "domain": "fundstack.com"
        }
      }
    ]
  },
  "sorts": [
    {
      "direction": "asc",
      "attribute": "name",
      "field": "last_name"
    }
  ],
  "limit": 500,
  "offset": 0
}'

{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
      },
      "created_at": "2022-11-21T13:22:49.061281000Z",
      "values": {
        "name": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "value": "Contract with Fundstack",
            "attribute_type": "text"
          }
        ],
        "stage": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "status": {
              "title": "In Progress",
              "id": {
                "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
                "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
                "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
                "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"
              },
              "is_archived": false,
              "celebration_enabled": false,
              "target_time_in_status": null
            },
            "attribute_type": "status"
          }
        ],
        "owner": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "referenced_actor_type": "workspace-member",
            "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "attribute_type": "actor-reference"
          }
        ],
        "value": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "currency_value": 4200,
            "currency_code": "USD",
            "attribute_type": "currency"
          }
        ],
        "associated_people": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "target_object": "people",
            "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
            "attribute_type": "record-reference"
          }
        ],
        "associated_company": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "target_object": "companies",
            "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
            "attribute_type": "record-reference"
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

This API uses OAuth 2.0 with the authorization code grant flow.

Body

application/json

filter

object

An object used to filter results to a subset of records. See the full guide to filtering and sorting here.

Example:

{
  "$and": [
    {
      "path": [
        ["deals", "associated_company"],
        ["companies", "domains"]
      ],
      "constraints": { "domain": "fundstack.com" }
    }
  ]
}

sorts

object[]

An object used to sort results. See the full guide to filtering and sorting here.

Sort by attribute

Example:

[
  {
    "direction": "asc",
    "attribute": "name",
    "field": "last_name"
  }
]

limit

number

The maximum number of results to return. Defaults to 500. See the full guide to pagination here.

Example:

500

offset

number

The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here.

Example:

0

Response

200

application/json

Success

data

object[]

required

data.id

object

required

data.created_at

string

required

When this record was created.

Example:

"2022-11-21T13:22:49.061281000Z"

data.values

object

required

An object with attribute_slug keys, and an array of value objects as the values. Attributes slugs (for example name or stage) can be used, including custom attribute slugs.

data.values.name

object[]

data.values.name.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.name.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.name.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.name.value

string

required

A raw text field. Values are limited to 10MB.

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."

data.values.name.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

text

Example:

"text"

data.values.stage

object[]

data.values.stage.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.stage.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.stage.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.stage.status

object

required

data.values.stage.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

status

Example:

"status"

data.values.owner

object[]

data.values.owner.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.owner.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.owner.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.owner.referenced_actor_type

enum<string>

required

The type of the referenced actor. Read more information on actor types here.

Available options:

api-token,

workspace-member,

system,

app

Example:

"workspace-member"

data.values.owner.referenced_actor_id

string | null

required

The ID of the referenced actor.

Example:

"50cf242c-7fa3-4cad-87d0-75b1af71c57b"

data.values.owner.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

actor-reference

Example:

"actor-reference"

data.values.value

object[]

data.values.value.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.value.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.value.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.value.currency_value

number

required

A numerical representation of the currency value. A decimal with a max of 4 decimal places.

Example:

99

data.values.value.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

currency

Example:

"currency"

data.values.value.currency_code

enum<string> | null

The ISO4217 currency code representing the currency that the value is stored in.

Available options:

AUD,

BRL,

BEL,

CAD,

CNY,

COP,

CZK,

DKK,

EUR,

HKD,

ISK,

INR,

ILS,

JPY,

KRW,

MYR,

MXN,

NTD,

NZD,

NGN,

NOK,

XPF,

PEN,

PHP,

PLN,

GBP,

SAR,

SGD,

ZAR,

SEK,

CHF,

AED,

USD

Example:

"USD"

data.values.associated_people

object[]

data.values.associated_people.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.associated_people.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.associated_people.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.associated_people.target_object

string

required

A slug identifying the object that the referenced record belongs to.

Example:

"people"

data.values.associated_people.target_record_id

string

required

A UUID to identify the referenced record.

Example:

"891dcbfc-9141-415d-9b2a-2238a6cc012d"

data.values.associated_people.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

data.values.associated_company

object[]

data.values.associated_company.active_from

string

required

The point in time at which this value was made "active". active_from can be considered roughly analogous to created_at.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.associated_company.active_until

string | null

required

The point in time at which this value was deactivated. If null, the value is active.

Example:

"2023-01-01T15:00:00.000000000Z"

data.values.associated_company.created_by_actor

object

required

The actor that created this value.

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.values.associated_company.target_object

string

required

A slug identifying the object that the referenced record belongs to.

Example:

"people"

data.values.associated_company.target_record_id

string

required

A UUID to identify the referenced record.

Example:

"891dcbfc-9141-415d-9b2a-2238a6cc012d"

data.values.associated_company.attribute_type

enum<string>

required

The attribute type of the value.

Available options:

record-reference

Example:

"record-reference"

Example:

{
  "name": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "value": "Contract with Fundstack",
      "attribute_type": "text"
    }
  ],
  "stage": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "status": {
        "title": "In Progress",
        "id": {
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
          "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
          "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
          "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"
        },
        "is_archived": false,
        "celebration_enabled": false,
        "target_time_in_status": null
      },
      "attribute_type": "status"
    }
  ],
  "owner": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "referenced_actor_type": "workspace-member",
      "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
      "attribute_type": "actor-reference"
    }
  ],
  "value": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "currency_value": 4200,
      "currency_code": "USD",
      "attribute_type": "currency"
    }
  ],
  "associated_people": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "target_object": "people",
      "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
      "attribute_type": "record-reference"
    }
  ],
  "associated_company": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": null,
      "created_by_actor": { "type": "system", "id": null },
      "target_object": "companies",
      "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
      "attribute_type": "record-reference"
    }
  ]
}

List deal record entries Assert a workspace record

curl --request POST \
  --url https://api.attio.com/v2/objects/deals/records/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {
    "$and": [
      {
        "path": [
          [
            "deals",
            "associated_company"
          ],
          [
            "companies",
            "domains"
          ]
        ],
        "constraints": {
          "domain": "fundstack.com"
        }
      }
    ]
  },
  "sorts": [
    {
      "direction": "asc",
      "attribute": "name",
      "field": "last_name"
    }
  ],
  "limit": 500,
  "offset": 0
}'

{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
      },
      "created_at": "2022-11-21T13:22:49.061281000Z",
      "values": {
        "name": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "value": "Contract with Fundstack",
            "attribute_type": "text"
          }
        ],
        "stage": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "status": {
              "title": "In Progress",
              "id": {
                "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
                "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
                "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
                "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"
              },
              "is_archived": false,
              "celebration_enabled": false,
              "target_time_in_status": null
            },
            "attribute_type": "status"
          }
        ],
        "owner": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "referenced_actor_type": "workspace-member",
            "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "attribute_type": "actor-reference"
          }
        ],
        "value": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "currency_value": 4200,
            "currency_code": "USD",
            "attribute_type": "currency"
          }
        ],
        "associated_people": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "target_object": "people",
            "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
            "attribute_type": "record-reference"
          }
        ],
        "associated_company": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "target_object": "companies",
            "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
            "attribute_type": "record-reference"
          }
        ]
      }
    }
  ]
}

People

Companies

Users

Deals

Workspaces

Authorizations

Body

Response