User Provisioning APIs

Getting started

Requests to the api will require a header named api-token. Your api token can be found in https://app.socialclimb.com under “Account API Key”.

The api base domain is https://api.socialclimb.com

curl --header "api-token: xxxx-xxx-xxxxx-xxxxxxxx" --header "content-type: application/json" https://api.socialclimb.com/v1/locations

Run this command to quickly test authorization

Content-Type header is required to be set as application/json

Users

Get Users

SocialClimb users can be many roles and provide access to the SocialClimb platform.

This endpoint retrieves all users

HTTP Request

GET /v1/users

JSON Response

{
  "items": [
    {
      "active": true,
      "email": "a.person@company.com",
      "id": 132532,
      "name": "Provider Name",
      "oid": "EXTERNAL_ID",
      "phone": "5555555555",
      "bio": "User Bio"
    },
    {
      "active": true,
      "email": "another.person@company.com",
      "id": 102344,
      "name": "Another Name"
    }
  ]
}

Invite User

Creates a pending user in the account awaiting the user creating his password

Role can be Administrator, Service User, Office Staff, Location Admin

HTTP Request

POST /v1/users

JSON Request Body

{
  "role": "Administrator",
  "name": "John Doe",
  "email": "a.person@company.com",
  "oid": "EXTERNAL_ID"
}

Update User

Updates a user with the supplied configuration

Role can be Administrator, Service User, Office Staff, Location Admin

HTTP Request

PUT /v1/users/:id

{
  "name": "John Doe",
  "role": "Location Admin",
  "oid": "EXTERNAL_ID"
}

Update User Image

Example multipart/form-data post body

Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name=""; filename="provider_image.png"
Content-Type: image/png


------WebKitFormBoundary7MA4YWxkTrZu0gW--

Adds or replaces a users image

Upload and set a users image

HTTP Request

PUT /v1/users/:id/image

Delete User

Deletes a user with the id on the url path

HTTP Request

DELETE /v1/users/:id