Customers

GET /customers/find

Look up an exact match for a given external_uid within a team. The team is determined by the API credentials used. This is intended so that you may link customer records on the Standard Cyborg Platform with customer information on your own server. After retrieving a customer record by external_uid, you may make subsequent requests to the Standard Cyborg Platform API using the customer uid.

Endpoint

GET /api/v2/customers/find

Parameters

Name Description type
external_uid required External customer identifier string

Request

Route

GET /api/v2/customers/find?external_uid=Customer+%23123

Headers

Accept: application/json
Content-Type: application/json
Access-Token: adeb2b54b99267ab731b30b1c2e549a033e61c47324b231570348ed088e26d94$$bHi4DJLbHv7TSnwNghVpHx0JbBmgqK7VH8XTvz/KsEtclqN7f+lNXqKZ+w==--rlXns2iSv2OlQs7J--xka0UfBZTss1DxEhCcGGbQ==
Api-Key: rEWfsr5th4TGdUFJ

Query Parameters

external_uid=Customer #123

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "customer": {
    "external_uid": "Customer #123",
    "team_uid": "RSNHMuLc",
    "uid": "m4vWJeLd"
  }
}