Skip to main content
GET
/
users
List users
curl --request GET \
  --url https://api.gospott.com/users \
  --header 'x-api-key: <api-key>'
{
  "users": [
    {
      "userId": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "avatarUrl": "<string>",
      "deactivatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Query Parameters

​
includeDeactivated
boolean

Include deactivated users in the response. Defaults to false.

Response

Successfully retrieved the list of users.

​
users
object[]
required