logo

Retrieve external identifiers

Retrieves a list of external identifiers.

SecuritySecretApiKey or JWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

Responses
200

List of external identifiers retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
externalIdentifier
required
string

ID of the referenced entity within an external service.

resource
string

Type of the resource.

Enum: "customers" "invoices" "invoice-items" "transactions" "journal-accounts" "journal-entries"
resourceId
string

ID of the resource entity.

service
string

Name of the external service.

Value: "quickbooks-online"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

Array
rel
string

Type of link.

Enum: "self" "externalService"
href
string

Link URL.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/external-identifiers
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Retrieve an external identifier