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": {
        "title": "Dr.",
        "firstName": "Pat",
        "middleName": "E",
        "lastName": "Doe",
        "suffix": "Jr."
      },
      "status": "ACTIVE",
      "emailAddress": "test@example.com",
      "phone": {
        "number": 15555551234,
        "type": "MOBILE"
      },
      "externalId": "1231012312-312-31231asda",
      "additionalAttributes": {
        "middleName": "user"
      },
      "isDeleted": false,
      "deletedAt": "2023-08-30T23:20:42.822Z",
      "createdAt": "2023-08-30T23:20:42.822Z",
      "updatedAt": "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
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
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
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.

Example:

false

Response

OK

The list of customers.

​
query
object

The pagination criteria.

​
data
object[]