List or search contacts

GET

/api/v1/contacts

const url = 'https://digize.com/api/v1/contacts?search=maya';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Lists contacts, the newest first, or the best matches first for a search. Returns up to 1,000 rows and the total that match. Search matches the start of words in names, emails and phone numbers. To go through more than 1,000, use crm.contacts.page.

Needs the crm:read permission.

Authorizations

apiKey
bearer

Parameters

Query Parameters

search

string

<= 200 characters

Example

maya

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.

object

key

additional properties

Array<string>

Responses

200

Done

application/json

object

rows

required

Array<object>

object

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
null

string format: date-time

lastActivityAt

required

string format: date-time

custom

required

Custom field values by field key.

object

key

additional properties

Any of:

string

createdAt

required

string format: date-time

total

required

number

Example

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

400

What was sent isn’t valid (invalid).

application/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.

application/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.

application/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).

application/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.

application/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"
  }
}