Get a contact

GET

/api/v1/contacts/{id}

const url = 'https://digize.com/api/v1/contacts/example';
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/example \
  --header 'x-api-key: <x-api-key>'

One contact with their tags, custom field values, orders and lifetime value.

Needs the crm:read permission.

Authorizations

apiKey
bearer

Parameters

Path Parameters

required

string

>= 1 characters <= 64 characters

Responses

200

Done

application/json

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

Example

{
  "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"
  }
}