Path parameters
-
userId string(uuid)
The ID of the user.
Responses
-
200 application/vnd.api+json
User found
-
401 application/vnd.api+json
OAuth token missing or invalid or a linked identity is missing.
Linked identity missing is a special case where you need to make sure that the user has additionally logged in / authorized with a third-party.
This is not relevant for most use-cases.
The specific error code that identifies a missing linked identity is
missing-linked-identity
Example:
{ "errors": [ { "id": "cbgmhslmp1o9or9kh1p0", "title": "Missing linked identity for authorized access", "detail": "Linked identity is needed to access this resource, please check why the user does not have a linked identity", "status": "401", "code": "missing-linked-identity" } ] }
-
403 application/vnd.api+json
Forbidden
-
404 application/vnd.api+json
Resource not found
-
501 application/vnd.api+json
Internal server error
GET /users/{userId}
curl \
-X GET https://api.pace.cloud/user/2024-2/users/c0daf39b-4df5-4241-9e7d-b1b85f829090 \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"data": {
"type": "User",
"id": "c0daf39b-4df5-4241-9e7d-b1b85f829090",
"attributes": {
"firstName": "John",
"lastName": "Smith",
"email": "user@example.com",
"phoneNumber": "+1 (425) 555-1212",
"pictureUrl": "https://api.pace.cloud/user/img/uztqwenbqw87t123jhg87t6876",
"gender": "male",
"createdAt": "2021-09-01T23:12:56Z",
"birthDate": "1997-07-21T00:00:00.000Z",
"address": {
"country": "DE",
"locality": "Karlsruhe",
"street": "Haid-und-Neu-Straße",
"houseNo": 18,
"additionalAddressLink": "z.H. John Smith",
"region": "BW",
"postalCode": 76131
},
"locale": "de-DE",
"zoneInfo": "Europe/Berlin"
}
}
}
Response examples (401)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (403)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (404)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (501)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}