Organizations

Get the organization

GET /api/v1/org/{orgId}

Credentials: API token or dashboard sign-in.

The organization this credential belongs to: its id, name, slug and retentionDays, how long a deleted project can be restored. Requires org:view.

Parameters

Responses

Example

curl -X GET "https://api.spicelabs.io/api/v1/org/<orgId>" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"

Update the organization

PUT /api/v1/org/{orgId}

Credentials: Dashboard sign-in only. API tokens are refused.

Changes the organization's name (at most 255 characters) or retentionDays (1 to 365), the number of days a deleted project can still be restored. A field you leave out is left as it is. The answer is the updated organization. Only a dashboard session may call this, never an API token. Requires org:manage_org.

Parameters

Request body

application/json (required)

UpdateOrganization

Responses

Example

curl -X PUT "https://api.spicelabs.io/api/v1/org/<orgId>" \
  -H "Authorization: Bearer $SPICE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '<JSON body>'

Delete the organization

DELETE /api/v1/org/{orgId}

What it changes: The organization and all its projects become unreachable for every member. Restoring it is a support request.

Credentials: Dashboard sign-in only. API tokens are refused.

Deletes the organization together with every project in it and every membership. It disappears immediately; after its retention period, 90 days unless changed with retentionDays, it may be removed for good. There is no API call to restore it. Only a dashboard session may call this, never an API token. Requires org:manage_org.

Parameters

Responses

Example

curl -X DELETE "https://api.spicelabs.io/api/v1/org/<orgId>" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"

List members

GET /api/v1/org/{orgId}/user

Credentials: API token or dashboard sign-in.

Every person who is a member of this organization, in users, each with their id, email and name. Requires org:view.

Parameters

Responses

Example

curl -X GET "https://api.spicelabs.io/api/v1/org/<orgId>/user" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"

Remove a member

DELETE /api/v1/org/{orgId}/user/{userId}

What it changes: This person loses access to the organization and its projects and their sign-ins end immediately; API tokens and Spice Passes they created keep working until canceled.

Credentials: Dashboard sign-in only. API tokens are refused.

Removes a person from this organization and from all of its teams, and ends their sign-ins to it immediately. API tokens and Spice Passes they created keep working until canceled from the project's credentials. The last member of an organization cannot be removed. Only a dashboard session may call this, never an API token. Requires org:remove_user.

Parameters

Responses

Example

curl -X DELETE "https://api.spicelabs.io/api/v1/org/<orgId>/user/<userId>" \
  -H "Authorization: Bearer $SPICE_API_TOKEN"