Skip to content
Aller au contenu
Charitips

API reference · Users

Get a user

GET/v1/users/{userId}

Get a user having access to the Charitips dashboard.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • userId#stringin pathrequired

Response

200 · User

No field is described in the spec.

  • userId#stringalways returned

  • firstName#stringalways returned

  • lastName#stringalways returned

  • email#stringalways returned

  • phone#string

  • pictureUrl#string

  • role#Rolealways returned

    ADMINMEMBERPAYROLL_MANAGER

  • persona#Persona

    CSRMARKETINGHRSALESCOMMUNICATIONPRODUCTSMBOTHER

  • accountId#string

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

Errors

  • 401Unauthorized

    Missing, expired or invalid access token.

    {
  "statusCode": 401,
  "message": "Unauthorized"
}
  • 404Not Found
    {
  "statusCode": 404,
  "message": "Not Found"
}
GET /v1/users/<userId>
curl -X GET https://api.sandbox.charitips.com/v1/users/<userId> \  -H "Authorization: Bearer $CHARITIPS_TOKEN"
Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.