Users

Endpointhttps://api.commonpaper.com

View and manage users in your organization

List Users

GET

https://api.commonpaper.com

/v1/users

This endpoint returns a list of all users within your Common Paper organization.

List Users › query Parameters

filter[email_eq]

string

Filter users by exact email address.

filter[email_cont]

string

Filter users where the email contains the given value.

List Users › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List Users › Responses

GET/v1/users

curl --request GET \
  --url https://api.commonpaper.com/v1/users \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "USER_UUID_1",
      "type": "user",
      "attributes": {
        "email": "[email protected]",
        "created_at": "2021-09-01T21:23:24.838Z",
        "updated_at": "2022-04-14T16:51:07.975Z",
        "name": "Ben Garvey",
        "title": "CTO",
        "id": "USER_UUID_1",
        "email_verified": true,
        "role": "admin"
      }
    },
    {
      "id": "USER_UUID_2",
      "type": "user",
      "attributes": {
        "email": "[email protected]",
        "created_at": "2021-11-10T19:04:39.835Z",
        "updated_at": "2021-11-10T19:05:21.578Z",
        "name": "Standard Garvey",
        "title": "Engineer",
        "id": "USER_UUID_2",
        "email_verified": false,
        "role": "standard"
      }
    },
    {
      "id": "USER_UUID_3",
      "type": "user",
      "attributes": {
        "email": "[email protected]",
        "created_at": "2022-04-07T15:28:23.867Z",
        "updated_at": "2022-04-07T15:28:57.573Z",
        "name": "Another Standard",
        "title": "Intern",
        "id": "USER_UUID_3",
        "email_verified": false,
        "role": "standard"
      }
    }
  ]
}

json

application/json

Get User

GET

https://api.commonpaper.com

/v1/users/{id}

This endpoint returns the profile information of a specific user within your Common Paper accouunt based on their uuid. Returns the user's profile information, such as their name, email, and role.

Get User › path Parameters

id

string · uuid · required

The UUID of the resource.

Get User › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get User › Responses

Templates Agreement Types

List Users

GET

https://api.commonpaper.com

/v1/users

This endpoint returns a list of all users within your Common Paper organization.

List Users › query Parameters

filter[email_eq]

string

Filter users by exact email address.

filter[email_cont]

string

Filter users where the email contains the given value.

List Users › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List Users › Responses

Get User

GET

https://api.commonpaper.com

/v1/users/{id}

This endpoint returns the profile information of a specific user within your Common Paper accouunt based on their uuid. Returns the user's profile information, such as their name, email, and role.

Get User › path Parameters

id

string · uuid · required

The UUID of the resource.

Get User › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.