Search for customer

Using this endpoint, you can search for customers based on filter conditions. By specifying offset and limit, you can narrow down your search results. In addition, using the isDelete property in the request body, you can filter for either deleted or non-deleted customers.

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.

x-fabric-request-id

string

A UUID of the request.

Body

application/json

The criteria to search for customers.

match

object

required

match

Show child attributes

match.additionalAttributes

object

The criteria to search for customers or their addresses based on additional attributes.

• Option 1
• Option 2

Show child attributes

match.additionalAttributes.key

string

required

The key for the additional attribute. This should be the field name given in the additionalAttributes schema.

match.additionalAttributes.op

enum<string>

required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options:

IN,

NOT_IN,

EQUALS,

CONTAINS,

NOT_EQUALS

match.additionalAttributes.value

string

The value of the string.

match.createdAt

object

The criteria to search for customers or their addresses based on a specific creation date or within a creation date range.

Show child attributes

match.createdAt.op

enum<string>

required

The type of search operation, such as equals, less than (LT), greater than (GT), less than or equal to (LTE), greater than or equal to (GTE), or within a specified range.

Available options:

EQUALS,

LTE,

GTE,

GT,

LT,

RANGE

match.createdAt.endCreatedAt

string

The ending value of the creation date range. This is used with the startCreatedAt property.

match.createdAt.startCreatedAt

string

The starting value of the creation date range. This is used with the endCreatedAt property.

match.createdAt.value

string

The time of creation, in UTC format.

match.deletedAt

object

The criteria to search for customers or their addresses based on a specific deletion date or within a deletion date range.

Show child attributes

match.deletedAt.op

enum<string>

required

The type of search operation, such as equals, less than (LT), greater than (GT), less than or equal to (LTE), greater than or equal to (GTE), or within a specified range.

Available options:

EQUALS,

LTE,

GTE,

GT,

LT,

RANGE

match.deletedAt.endDeletedAt

string

The ending value of the deletedAt date range. This is used with the startDeletedAt property.

match.deletedAt.startDeletedAt

string

The starting value of the deletedAt date range. This is used with the endDeletedAt property.

match.deletedAt.value

string

The time of deletion, in UTC format.

match.emailAddress

object

The criteria to search for customers based on their email.

Show child attributes

match.emailAddress.op

enum<string>

required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options:

IN,

NOT_IN,

EQUALS,

CONTAINS,

NOT_EQUALS

match.emailAddress.value

string

required

The customer's email address.

match.externalId

object

The criteria to search for customers based on their externalId.

Show child attributes

match.externalId.op

enum<string>

required

The type of search operation.

Available options:

IN,

EQUALS

match.externalId.value

string

required

The value of the externalId.

match.firstName

object

The criteria to search for customers based on their first name.

Show child attributes

match.firstName.op

enum<string>

required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options:

IN,

NOT_IN,

EQUALS,

CONTAINS,

NOT_EQUALS

match.firstName.value

string

required

The customer's first name.

match.id

object

A unique identifier of the search criteria.

Show child attributes

match.id.op

enum<string>

required

The type of search operation.

Available options:

IN,

EQUALS

match.id.value

string

required

A 24-character system-generated ID of the given search criteria.

match.isDeleted

boolean

A flag indicating whether the search results should include only deleted addresses. Set to true to include only deleted addresses and false to exclude deleted addresses.

match.lastName

object

The criteria to search for customers based on their last name.

Show child attributes

match.lastName.op

enum<string>

required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options:

IN,

NOT_IN,

EQUALS,

CONTAINS,

NOT_EQUALS

match.lastName.value

string

required

The customer's last name.

match.status

object

The criteria to search for customers based on their account status.

Show child attributes

match.status.op

enum<string>

required

The type of search operation. Multiple values, separated by commas, can be used for the IN and NOT_IN operations, while only a single value can be used for the EQUALS, CONTAINS, and NOT_EQUALS operations.

Available options:

IN,

NOT_IN,

EQUALS,

CONTAINS,

NOT_EQUALS

match.status.value

enum<string>

required

The customer's account status.

Available options:

ACTIVE,

INACTIVE,

BLOCKED

match.updatedAt

object

The criteria to search for customers or their addresses based on a specific date or date range in which the record was updated.

Show child attributes

match.updatedAt.op

enum<string>

required

The type of search operation, such as equals, less than (LT), greater than (GT), less than or equal to (LTE), greater than or equal to (GTE), or within a specified range.

Available options:

EQUALS,

LTE,

GTE,

GT,

LT,

RANGE

match.updatedAt.endUpdatedAt

string

The ending value of the updatedAt date range. This is used with the startUpdatedAt property.

match.updatedAt.startUpdatedAt

string

The starting value of the updatedAt date range. This is used with the endUpdatedAt property.

match.updatedAt.value

string

The time of last update, in UTC format.

limit

number

default:

20

The maximum number of records in a single page.

offset

number

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.

sort

string

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

Response

200 - application/json

The list of customers.

data

object[]

Show child attributes

data.createdAt

string

required

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

data.emailAddress

string

required

The customer's email.

data.id

string

required

A 24-character system-generated customer ID.

data.isDeleted

boolean

required

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

data.name

object

required

The full name of the customer.

Show child attributes

data.name.firstName

string

required

The customer's first name.

data.name.lastName

string

required

The customer's last name.

data.name.middleName

string

The customer's middle name.

data.name.suffix

string

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

data.name.title

string

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

data.updatedAt

string | null

required

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

data.additionalAttributes

object

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

data.deletedAt

string | null

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

data.externalId

string

A UUID of the customer.

data.phone

object

Show child attributes

data.phone.number

string

The customer's phone number.

data.phone.type

enum<string> | null

The type of phone number.

Available options:

MOBILE,

HOME,

BUSINESS

data.status

enum<string>

The status of the customer.

Available options:

ACTIVE,

INACTIVE,

BLOCKED

query

object

The pagination criteria.

Show child attributes

query.count

number

The total number of records in the response.

query.limit

number

The maximum number of records per page.

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.