Skip to content

List profit centers

Request

Returns the stored profit centers of the company, newest first unless sort says otherwise.

Security
OAuth2(Required scopes: enrichment.read)
Query
offsetinteger, >= 0

A zero-based offset of the first item in the data collection to return.

limitinteger, [ 1 .. 1000 ]

Maximum number of records in the response. Values above 1000 are capped to 1000; the limit field of the response shows the value that was used.

Default:100
sortstring

Order of the records. -createdAt returns the newest first, createdAt and +createdAt the oldest first. Records created at the same instant are returned in a stable order.

Default:"-createdAt"
Enum:"createdAt""+createdAt""-createdAt"
externalIdArray of strings

Return only the records with these external ids. Repeat the parameter for several ids.

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/enrichment/profit-centers?offset=0&limit=100&sort=createdAt&externalId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

One page of profit centers

Bodyapplication/json
dataArray of objects(profitCenterRecord)required
limitintegerrequired

The limit used for this page. Same as the limit query parameter unless it exceeded the maximum.

Example:100
offsetintegerrequired

The offset used for this page.

Example:0
totalCountintegerrequired

Total number of records matching the request, ignoring limit and offset.

Example:1234
Response
{ "data": [ { … } ], "limit": 100, "offset": 0, "totalCount": 1234 }