For the complete documentation index, see llms.txt. This page is also available as Markdown.

Users

Read the users in your organisation.

Get all users

get

Get a list of all members in your organization. This list includes all the members including the ones who are removed from the organization.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

Responses
200

A bare JSON array of users — not wrapped in an envelope.

application/json
_idstringOptional
firstNamestringOptional
lastNamestringOptional
emailstring · emailOptional
phonestringOptional
rolestringOptional
timezonestringOptional
get/users

Get a user

get

Get a list of all members in your organization. This list includes all the members including the ones who are removed from the organization.

Authorizations
x-api-keystringRequired

Your organisation's API key. Create one in the Spike dashboard under Settings > API. Sent on every request as the x-api-key header.

Path parameters
userIdstringRequired

userId parameter

Header parameters
x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

Responses
200

Successful response

application/json
_idstringOptional
firstNamestringOptional
lastNamestringOptional
emailstring · emailOptional
phonestringOptional
rolestringOptional
timezonestringOptional
get/users/{userId}

Last updated