Skip to content

Get a single customer by ID

Request

Security
bearerAuth
Path
organizationIdstringrequired

Organization ID of the member accessing the resource

Example:my-organization-id
customerIdinteger, ( 0 .. 9007199254740991 ]required
curl -i -X GET \
  'https://docs.api.hook.co/_mock/v1/openapi/organizations/my-organization-id/customers/{customerId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
idinteger, ( 0 .. 9007199254740991 ]required
Example:1234
namestringrequired
Example:"Acme Corp"
parentIdinteger or null, ( 0 .. 9007199254740991 ]required

The customer this one is nested under, such as its holding company. Null at the top of a hierarchy.

Example:1200
citystring or nullrequired
Example:"San Francisco"
countrystring or nullrequired
Example:"US"
regionstring or nullrequired
Example:"US"
timezonestring or nullrequired
Example:"America/Los_Angeles"
domainstring or nullrequired
Example:"acme.com"
employeeCountinteger or null, [ -9007199254740991 .. 9007199254740991 ]required
Example:500
segmentstring or nullrequired
Example:"Enterprise"
memberRolesArray of objects(CustomerMemberRole)required
customFieldsArray of objects(CustomerCustomField)required
productsArray of objects(CustomerProduct)required
sourcesArray of objects(CustomerSource)required
updatedDatestring, (date-time)required
Response
{ "id": 1234, "name": "Acme Corp", "parentId": 1200, "city": "San Francisco", "country": "US", "region": "US", "timezone": "America/Los_Angeles", "domain": "acme.com", "employeeCount": 500, "segment": "Enterprise", "memberRoles": [ { … } ], "customFields": [ { … } ], "products": [ { … } ], "sources": [ { … } ], "updatedDate": "2019-08-24T14:15:22Z" }