Chevre REST API Endpoints — Users and Member Management

Member and invitation endpoints let you query who has access to your workspaces and control team membership programmatically. Members are users who have accepted an invitation and joined the workspace. Invitations represent pending access grants that have not yet been accepted. All requests require your API key in the Authorization header as Bearer <your_api_key>.

List workspace members

GET https://api.chevre.io/v1/workspaces/{workspace_id}/members Returns an array of all active members in the specified workspace. Pending invitations that have not yet been accepted are not included — use the List invitations endpoint for those.

Path parameters

workspace_id

string

required

The unique identifier of the workspace whose members you want to list (e.g. ws_01HXYZ).

Example request

curl --request GET \
  --url "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members" \
  --header "Authorization: Bearer <your_api_key>" \
  --header "Accept: application/json"

import requests

response = requests.get(
    "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members",
    headers={"Authorization": "Bearer <your_api_key>"},
)
print(response.json())

const response = await fetch(
  "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members",
  {
    headers: {
      Authorization: "Bearer <your_api_key>",
      Accept: "application/json",
    },
  }
);
const data = await response.json();
console.log(data);

Example response

200

{
  "data": [
    {
      "id": "mem_01PQR",
      "email": "alice@acme.com",
      "name": "Alice Johnson",
      "role": "admin",
      "status": "active",
      "joined_at": "2024-01-20T11:00:00Z"
    },
    {
      "id": "mem_02STU",
      "email": "bob@acme.com",
      "name": "Bob Smith",
      "role": "editor",
      "status": "active",
      "joined_at": "2024-03-05T08:30:00Z"
    }
  ]
}

Response fields

data

array

An array of member objects for the workspace.

Show member object

string

The unique identifier for the workspace membership, prefixed with mem_.

string

The email address of the member.

name

string

The full display name of the member.

role

string

The member’s role in the workspace. One of "owner", "admin", "editor", or "viewer".

status

string

The membership status. Active members have the value "active".

joined_at

string

ISO 8601 timestamp of when the member accepted their invitation and joined the workspace.

Invite a user

POST https://api.chevre.io/v1/workspaces/{workspace_id}/invitations Sends an email invitation to the specified address, granting the recipient access to the workspace with the given role when they accept. If the email address already belongs to an active member of the workspace, the request returns a 409 Conflict error.

Invitations expire after 7 days. If the recipient does not accept within that window, you will need to send a new invitation. You can monitor invitation status using the status field on the invitation object.

Path parameters

workspace_id

string

required

The unique identifier of the workspace to invite the user into (e.g. ws_01HXYZ).

Request body

string

required

The email address of the person you want to invite. Must be a valid email format.

role

string

required

The role to assign to the user when they accept the invitation. Accepted values:

"owner" — full administrative control, including billing and workspace deletion.
"admin" — can manage members, projects, and all workspace settings.
"editor" — can create and edit projects and automations, but cannot manage members.
"viewer" — read-only access to all shared projects in the workspace.

Example request

curl --request POST \
  --url "https://api.chevre.io/v1/workspaces/ws_01HXYZ/invitations" \
  --header "Authorization: Bearer <your_api_key>" \
  --header "Content-Type: application/json" \
  --data '{
    "email": "carol@acme.com",
    "role": "editor"
  }'

import requests

response = requests.post(
    "https://api.chevre.io/v1/workspaces/ws_01HXYZ/invitations",
    json={"email": "carol@acme.com", "role": "editor"},
    headers={"Authorization": "Bearer <your_api_key>"},
)
print(response.json())

const response = await fetch(
  "https://api.chevre.io/v1/workspaces/ws_01HXYZ/invitations",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer <your_api_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      email: "carol@acme.com",
      role: "editor",
    }),
  }
);
const data = await response.json();
console.log(data);

Example response

201

{
  "data": {
    "id": "inv_01VWX",
    "email": "carol@acme.com",
    "role": "editor",
    "status": "pending",
    "expires_at": "2024-06-08T14:22:00Z",
    "created_at": "2024-06-01T14:22:00Z"
  }
}

Response fields

data

object

The newly created invitation object.

Show invitation object

string

The unique identifier for the invitation, prefixed with inv_.

string

The email address the invitation was sent to.

role

string

The role the invitee will receive upon accepting.

status

string

The current status of the invitation. Starts as "pending". Changes to "accepted" when the recipient joins, or "expired" after the expiry window passes.

expires_at

string

ISO 8601 timestamp of when the invitation will expire if not accepted.

created_at

string

ISO 8601 timestamp of when the invitation was created.

Update a member’s role

PATCH https://api.chevre.io/v1/workspaces/{workspace_id}/members/{member_id} Updates the role of an existing workspace member. You must have admin or owner permissions in the workspace to update member roles. An owner cannot downgrade their own role — another owner must perform that action.

Path parameters

workspace_id

string

required

The unique identifier of the workspace (e.g. ws_01HXYZ).

member_id

string

required

The unique identifier of the member whose role you want to update (e.g. mem_02STU).

Request body

role

string

required

The new role to assign to the member. Accepted values: "owner", "admin", "editor", or "viewer".

Example request

curl --request PATCH \
  --url "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members/mem_02STU" \
  --header "Authorization: Bearer <your_api_key>" \
  --header "Content-Type: application/json" \
  --data '{
    "role": "admin"
  }'

import requests

response = requests.patch(
    "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members/mem_02STU",
    json={"role": "admin"},
    headers={"Authorization": "Bearer <your_api_key>"},
)
print(response.json())

const response = await fetch(
  "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members/mem_02STU",
  {
    method: "PATCH",
    headers: {
      Authorization: "Bearer <your_api_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ role: "admin" }),
  }
);
const data = await response.json();
console.log(data);

Example response

200

{
  "data": {
    "id": "mem_02STU",
    "email": "bob@acme.com",
    "name": "Bob Smith",
    "role": "admin",
    "status": "active",
    "joined_at": "2024-03-05T08:30:00Z"
  }
}

Response fields

data

object

The updated member object.

Show member object

string

The unique identifier for the workspace membership.

string

The email address of the member.

name

string

The full display name of the member.

role

string

The member’s updated role in the workspace.

status

string

The membership status. Active members have the value "active".

joined_at

string

ISO 8601 timestamp of when the member originally joined the workspace.

Remove a member

DELETE https://api.chevre.io/v1/workspaces/{workspace_id}/members/{member_id} Removes a member from the workspace, immediately revoking their access to all projects and data within it. The removed member’s account is not deleted — they simply lose access to this workspace.

Removing a member immediately revokes their access. Any automations or tasks assigned to the removed member will remain but become unassigned. This action cannot be undone — you must send a new invitation if you want to restore their access.

Path parameters

workspace_id

string

required

The unique identifier of the workspace (e.g. ws_01HXYZ).

member_id

string

required

The unique identifier of the member to remove (e.g. mem_02STU).

Example request

curl --request DELETE \
  --url "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members/mem_02STU" \
  --header "Authorization: Bearer <your_api_key>"

import requests

response = requests.delete(
    "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members/mem_02STU",
    headers={"Authorization": "Bearer <your_api_key>"},
)
print(response.status_code)  # 204

const response = await fetch(
  "https://api.chevre.io/v1/workspaces/ws_01HXYZ/members/mem_02STU",
  {
    method: "DELETE",
    headers: {
      Authorization: "Bearer <your_api_key>",
    },
  }
);
// Successful removal returns 204 No Content
console.log(response.status); // 204

Example response

204

// No content returned on successful removal

A successful removal returns HTTP 204 No Content with an empty response body.

​List workspace members

​Path parameters

​Example request

​Example response

​Response fields

​Invite a user

​Path parameters

​Request body

​Example request

​Example response

​Response fields

​Update a member’s role

​Path parameters

​Request body

​Example request

​Example response

​Response fields

​Remove a member

​Path parameters

​Example request

​Example response

List workspace members

Path parameters

Example request

Example response

Response fields

Invite a user

Path parameters

Request body

Example request

Example response

Response fields

Update a member’s role

Path parameters

Request body

Example request

Example response

Response fields

Remove a member

Path parameters

Example request

Example response