Page through contacts

GET

/api/v1/contacts/page

curl --request GET \
  --url https://digize.com/api/v1/contacts/page \
  --header 'x-api-key: <x-api-key>'

• Digize

A page of contacts, the newest first, searches included, with the same filters as crm.contacts.list and how many match in all. Pass nextCursor back as cursor for the next page; contacts added in between don’t shift the pages.

Needs the crm:read permission.

Authorizations

• apiKey
• bearer

Parameters

Query Parameters

search

string

<= 200 characters

stage

Array<string>

Allowed values: lead customer repeat

source

Array<string>

Allowed values: checkout form booking import manual message

ownerId

Array<string>

tag

Array<string>

companyId

string

>= 1 characters <= 64 characters

fields

Dropdown fields’ options to match, by field key.

Dropdown fields’ options to match, by field key.

object

key

additional properties

Array<string>

cursor

The nextCursor of the page before. Leave it out for the first page.

string

<= 400 characters

The nextCursor of the page before. Leave it out for the first page.

limit

Rows on the page: 50 unless it says, 100 at most.

integer

>= 1 <= 100

Rows on the page: 50 unless it says, 100 at most.

Responses

200

Done

Media typeapplication/json

object

rows

required

Array<object>

object

id

required

string

firstName

required

string

lastName

required

string

name

required

string

email

required

string | null

phone

required

In E.164, such as +15125550142.

string | null

city

required

string | null

companyId

required

string | null

companyName

required

string | null

ownerId

required

The member who looks after them, by user id.

string | null

source

required

string

Allowed values: checkout form booking import manual message

tags

required

Array<string>

stage

required

Lead: hasn’t ordered; customer: one or two orders; repeat: three or more.

string

Allowed values: lead customer repeat

orders

required

number

lifetimeValue

required

What they’ve paid, less refunds, in minor units.

number

lastOrderAt

required

Any of:

string

string format: date-time

null

null

lastActivityAt

required

string format: date-time

custom

required

Custom field values by field key.

object

key

additional properties

Any of:

string

string

number

number

boolean

boolean

Array<string>

Array<string>

createdAt

required

string format: date-time

nextCursor

required

Pass it as cursor for the next page; null on the last.

string | null

total

required

number

Example

{
  "rows": [
    {
      "source": "checkout",
      "stage": "lead"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}