Get customers

curl --request GET \
  --url https://api.fabric.inc/v3/Customers \
  --header 'Authorization: Bearer <token>'

{
  "query": {
    "offset": 0,
    "limit": 20,
    "count": 100
  },
  "data": [
    {
      "id": "61df41892bf06d00092d0d8a",
      "name": {
        "firstName": "Pat",
        "lastName": "Doe",
        "title": "Dr.",
        "middleName": "E",
        "suffix": "Jr."
      },
      "emailAddress": "[email protected]",
      "isDeleted": false,
      "createdAt": "2023-08-30T23:20:42.822Z",
      "updatedAt": "2023-08-30T23:20:42.822Z",
      "status": "ACTIVE",
      "phone": {
        "number": 15555551234,
        "type": "MOBILE"
      },
      "externalId": "1231012312-312-31231asda",
      "additionalAttributes": {
        "middleName": "user"
      },
      "deletedAt": "2023-08-30T23:20:42.822Z"
    }
  ]
}

GET

Customers

Get customers

curl --request GET \
  --url https://api.fabric.inc/v3/Customers \
  --header 'Authorization: Bearer <token>'

{
  "query": {
    "offset": 0,
    "limit": 20,
    "count": 100
  },
  "data": [
    {
      "id": "61df41892bf06d00092d0d8a",
      "name": {
        "firstName": "Pat",
        "lastName": "Doe",
        "title": "Dr.",
        "middleName": "E",
        "suffix": "Jr."
      },
      "emailAddress": "[email protected]",
      "isDeleted": false,
      "createdAt": "2023-08-30T23:20:42.822Z",
      "updatedAt": "2023-08-30T23:20:42.822Z",
      "status": "ACTIVE",
      "phone": {
        "number": 15555551234,
        "type": "MOBILE"
      },
      "externalId": "1231012312-312-31231asda",
      "additionalAttributes": {
        "middleName": "user"
      },
      "deletedAt": "2023-08-30T23:20:42.822Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token.

Headers

x-fabric-tenant-id

string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Example:

"517fa9dfd42d8b00g1o3k312"

x-fabric-request-id

string

A UUID of the request.

Query Parameters

offset

integer<int32>

default:0

The number of records to skip before returning records. For example, when offset is 20 and limit's 10, this endpoint returns records from 21 to 30.

Example:

0

limit

integer<int32>

default:10

The maximum number of records in a single page.

Example:

2

sort

string

The criteria to sort results, where - indicates a descending order and + indicates an ascending order. You can apply sorting to the following fields - createdAt, updatedAt, firstName, lastName, emailAddress and status.

Example:

"-updatedAt"

isDeleted

enum<boolean>

A flag indicating whether only the deleted customers need to be included. Set to true to include only the deleted customers and false to exclude deleted customers.

Available options:

true,

false

Example:

false

Response

The list of customers.

query

object

The pagination criteria.

Show child attributes

query.offset

number

The number of records to skip before returning records. For example, when offset is 20 and limit's 10, you get records from 21 to 30. When they're not specified, you get up to 10 records.

Example:

0

query.limit

number

The maximum number of records per page.

Example:

20

query.count

number

The total number of records in the response.

Example:

100

data

object[]

Show child attributes

data.id

string

required

A 24-character system-generated customer ID.

Example:

"61df41892bf06d00092d0d8a"

data.name

object

required

The full name of the customer.

Show child attributes

data.name.firstName

string

required

The customer's first name.

Example:

"Pat"

data.name.lastName

string

required

The customer's last name.

Example:

"Doe"

data.name.title

string

The customer's title, such as Mr., Mrs, and Dr.

Example:

"Dr."

data.name.middleName

string

The customer's middle name.

Example:

"E"

data.name.suffix

string

The suffix for the customer's name, such as Jr., PhD, and more.

Example:

"Jr."

data.emailAddress

string<email>

required

The customer's email.

Example:

"[email protected]"

data.isDeleted

boolean

required

A flag indicating whether the customer data is deleted. true indicates the customer data is deleted and false indicates otherwise.

Example:

false

data.createdAt

string<date-time>

required

The time when the customer was added, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"

data.updatedAt

string<date-time> | null

required

The time when the customer details were last updated, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"

data.status

enum<string>

The status of the customer.

Available options:

ACTIVE,

INACTIVE,

BLOCKED

Example:

"ACTIVE"

data.phone

object

Show child attributes

data.phone.number

string

The customer's phone number.

Example:

15555551234

data.phone.type

enum<string> | null

The type of phone number.

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

data.externalId

string

A UUID of the customer.

Example:

"1231012312-312-31231asda"

data.additionalAttributes

object

A placeholder for additional info, in key-value pairs.

Example:

{ "middleName": "user" }

data.deletedAt

string<date-time> | null

The time when the customer data was deleted, in UTC format.

Example:

"2023-08-30T23:20:42.822Z"

Partially update customer details Update customer details

⌘I

Alerts

Settings

Customers

Get customers

Authorizations

Headers

Query Parameters

Response