API Reference

👥 Manage Team members in Spreadly

SCIM is used by Single Sign-On (SSO) services and identity providers to manage people across a variety of tools, including Spreadly. This SCIM implementation targets version 2.0 of the protocol.

🧑‍💻 Accessing the SCIM API

The SCIM methods are accessed over HTTP. The base URL for all calls to the SCIM API is https://spreadly.app/api/v1/scim. All SCIM methods are branches of this base URL.

🔑 Get an access token

A Bearer token is required to access the SCIM endpoints. You can get your SCIM access token from "Team > Members". The token is only visible for enterprise customers.

🛠️ Use the token in a SCIM API request

The API token must be included via an Authorization header with a type of Bearer when calling any of the SCIM methods. Provide a JSON request body for POST, PUT, and PATCH write operations, and set your HTTP Content-Type header to application/json.

A SCIM call may take a form like this:

GET /api/v1/scim/Users HTTP/1.1
Host: spreadly.app
Accept: application/json
Authorization: Bearer scim-token_...

🏷️ User and Groups attributes

You can checkout User Provisioning with SCIM 2.0 to retrieve the full list of all supported user and groups attributes.