List Contacts

GET

unified

crm

contacts

curl --request GET \
  --url https://api.stackone.com/unified/crm/contacts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next_page": "<string>",
  "next": "<string>",
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "first_name": "Steve",
      "last_name": "Wozniak",
      "company_name": "Apple Inc.",
      "emails": [
        "steve@apple.com"
      ],
      "phone_numbers": [
        "123-456-7890"
      ],
      "deal_ids": [
        "deal-001",
        "deal-002"
      ],
      "remote_deal_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
      ],
      "account_ids": [
        "account-123",
        "account-456"
      ],
      "remote_account_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
      ],
      "custom_fields": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "name": "Training Completion Status",
          "value": "Completed",
          "value_id": "value_456",
          "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
        }
      ],
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

proxy

object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at"

filter

object | null

Filter parameters that allow greater customisation of the list response

page

string | null

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

string | null

The unified cursor

updated_after

string | null

deprecated

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

include

string | null

The comma separated list of fields that will be included in the response

Example:

"custom_fields"

Response

200

application/json

The list of contacts was retrieved.

data

object[]

required

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.first_name

string | null

The contact first name

Example:

"Steve"

data.last_name

string | null

The contact last name

Example:

"Wozniak"

data.company_name

string | null

The contact company name

Example:

"Apple Inc."

data.emails

string[] | null

List of contact email addresses

Example:

["steve@apple.com"]

data.phone_numbers

string[] | null

List of contact phone numbers

Example:

["123-456-7890"]

data.deal_ids

string[] | null

List of associated deal IDs

Example:

["deal-001", "deal-002"]

data.remote_deal_ids

string[] | null

Provider's list of associated deal IDs

Example:

[
  "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
]

data.account_ids

string[] | null

List of associated account IDs

Example:

["account-123", "account-456"]

data.remote_account_ids

string[] | null

Provider's list of associated account IDs

Example:

[
  "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
]

data.custom_fields

object[] | null

Contact custom fields

data.created_at

string | null

Timestamp when the contact was created

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string | null

Timestamp when the contact was last updated

Example:

"2021-01-01T01:01:01.000Z"

next_page

string | null

deprecated

string | null

raw

object[] | null

Was this page helpful?

Suggest edits

Get Contact Update Contact (early access)

curl --request GET \
  --url https://api.stackone.com/unified/crm/contacts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next_page": "<string>",
  "next": "<string>",
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "first_name": "Steve",
      "last_name": "Wozniak",
      "company_name": "Apple Inc.",
      "emails": [
        "steve@apple.com"
      ],
      "phone_numbers": [
        "123-456-7890"
      ],
      "deal_ids": [
        "deal-001",
        "deal-002"
      ],
      "remote_deal_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
      ],
      "account_ids": [
        "account-123",
        "account-456"
      ],
      "remote_account_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
      ],
      "custom_fields": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "name": "Training Completion Status",
          "value": "Completed",
          "value_id": "value_456",
          "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
        }
      ],
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

CRM

Common Guides

API Reference

Authorizations

Headers

Query Parameters

Response