External identifiers

Use external identifier operations to associate entities such as customers, invoices, transactions, journal accounts, journal entries, and more with external services.

To use external identifiers, you must use an active service credential.

Operations

Retrieve external identifiers

Request

Retrieves a list of external identifiers.

Security
SecretApiKey or JWT
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/external-identifiers?filter=string&sort=string&limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of external identifiers retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
resourcestringread-only

Type of resource.

Enum:"customers""invoices""invoice-items""transactions""journal-accounts""journal-entries"
resourceIdstringread-only

ID of the resource.

servicestringread-only

Name of the external service.

Value:"quickbooks-online"
externalIdentifierstringrequired

ID of the referenced entity within an external service.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "resource": "customers",
    "resourceId": "string",
    "service": "quickbooks-online",
    "externalIdentifier": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]