Skip to main content

Get User by external ID

GET$BEEDEEZ_API/v1/users/externalId/{externalId}

Get User by external ID

Get User by external ID.

Path Parameters
`externalId` string — REQUIRED

Responses

200

Ok

Schema — OPTIONAL
`externalId` string
`locale` string
`points` double
`login` string
`email` string
`firstname` string
`lastname` string
`alias` string
`id` string

400

Invalid externalId

Schema — OPTIONAL
`statusCode` double
`kind` string
`message` string

404

User not found

Schema — OPTIONAL
`statusCode` double
`kind` string
`message` string

Authorization

AuthorizationBearer access tokenadmin scopeHow to get one

Path parameters

externalIdstringrequired

Response

200 OKobject

externalIdstring

localestring

pointsdouble

loginstring

emailstring

firstnamestring

lastnamestring

aliasstring

idstring

Errors

400Invalid externalId

404User not found

curl "$BEEDEEZ_API/v1/users/externalId/$externalId" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response200 OKExample

{
  "externalId": "string",
  "locale": "string",
  "points": 0,
  "login": "string",
  "email": "string",
  "firstname": "string",
  "lastname": "string",
  "alias": "string",
  "id": "string"
}

Try it

Stuck on an integration?

Write to the developer team with your request ID and we'll get back to you quickly.

dev@beedeez.com Help Center