List all contacts for a customer

curl --request GET \
  --url https://dev.seqhq.io/api/customers/{customer}/contacts \
  --header 'Authorization: <authorization>'

{
  "items": [
    {
      "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
      "name": "John Smith",
      "email": "[email protected]",
      "billingPreference": "NONE",
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z",
      "archivedAt": "2023-06-28T16:47:00Z"
    }
  ]
}

GET

customers

{customer}

contacts

List all contacts for a customer

curl --request GET \
  --url https://dev.seqhq.io/api/customers/{customer}/contacts \
  --header 'Authorization: <authorization>'

{
  "items": [
    {
      "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
      "name": "John Smith",
      "email": "[email protected]",
      "billingPreference": "NONE",
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z",
      "archivedAt": "2023-06-28T16:47:00Z"
    }
  ]
}

Headers

Authorization

string

required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version

enum<string>

Use this header to select an API version

Available options:

2024-07-30

Path Parameters

customer

string

required

The Customer ID

Query Parameters

includeArchived

boolean

Include archived contacts in results

Response

items

object[]

required

Contacts

Show child attributes

items.id

string

required

Unique ID

Example:

"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"

items.name

string

required

Full name of this contact

Example:

"John Smith"

items.email

string

required

Email address of this contact

Example:

"[email protected]"

items.billingPreference

enum<string>

required

Billing preference. Whether this contact receives billing communications. Options are NONE, STANDARD or PRIMARY. For a given customer, if any contacts receive billing communications then at least one contact must be designated PRIMARY for billing.

Available options:

PRIMARY,

STANDARD,

NONE

Example:

"NONE"

items.createdAt

string

required

Time of creation. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

items.updatedAt

string

required

Time of last update. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

items.archivedAt

string

Time of archive. Formatted as an ISO 8601 timestamp.

Example:

"2023-06-28T16:47:00Z"

Example:

[
  {
    "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
    "name": "John Smith",
    "email": "[email protected]",
    "billingPreference": "NONE",
    "createdAt": "2022-06-28T16:47:00Z",
    "updatedAt": "2022-06-28T16:47:00Z",
    "archivedAt": "2023-06-28T16:47:00Z"
  }
]

Get customer by alias

Create a new contact

⌘I

API Reference

Latest Live API

Version 2024-07-30

List all contacts for a customer

Headers

Path Parameters

Query Parameters

Response