SurveyTale API Docs

Authorization

apiKeyAuth

x-api-key<token>

Use your SurveyTale x-api-key to authenticate.

In: header

Path Parameters

organizationId*string

The ID of the organization

Match^[0-9a-z]+$

Formatcuid2

Query Parameters

limit?number

Number of items to return

Default50

Range1 <= value <= 250

skip?number

Number of items to skip

Range0 <= value

sortBy?string

Sort by field

Default"createdAt"

Value in"createdAt" | "updatedAt"

order?string

Sort order

Default"desc"

Value in"asc" | "desc"

startDate?string

Start date

endDate?string

End date

filterDateField?string

Date field to filter by

Value in"createdAt" | "updatedAt"

id?string

email?string

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/users"

{
  "data": [
    {
      "id": "string",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "lastLoginAt": "2021-01-01T00:00:00.000Z",
      "isActive": true,
      "name": "John Doe",
      "email": "example@example.com",
      "role": "member",
      "teams": [
        "team1",
        "team2"
      ]
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}