Get summary info for an API user

GET /api_users/summary

Get all summarized information pertaining to the API user making the request.

Responses

200

API User
Hide response attributes Show response attributes object
- api_user_id string Required
  
  The unique ID in Canopy for this API user
- organization_name string Required
  
  The organization to which the API user belongs.
- name_first string Required
  
  The first name of the API user.
- name_last string Required
  
  The last name of the API user.
- email string(email) Required
  
  The email address of this API User
- phone string | null
  
  Phone number of the API user
- role integer Required
  
  The role of this user in the API
401

Unauthorized.
403

Forbidden.
404

No API user found.
429

Too many requests.
default

Unexpected Error.

GET /api_users/summary

curl \
 -X GET https://sandbox-api.canopyservicing.com/api_users/summary \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
  "organization_name": "Lever Card 3000",
  "name_first": "Analise",
  "name_last": "Goldberg",
  "email": "marissa@globex.com",
  "phone": "1-123-456-7890",
  "role": 1
}

Response examples (200)

{
  "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
  "organization_name": "Lever Card 3000",
  "name_first": "Analise",
  "name_last": "Goldberg",
  "email": "marissa@globex.com",
  "phone": "1-123-456-7890",
  "role": 1
}