TEtectonic
Users

Retrieve users

Changed on

Retrieves users.

get/user

Request

Query parameters

active_in_seasonstring

Filter by the season the user is active in, identified by season slug.

confirmation'confirmed' | 'pending'

Filter by account confirmation status.

entries'current_season' | 'none_current_season' | 'archived_season' | 'none'

Filter by entry status.

languagestring

Filter by language code.

rolestring

Filter by role slug.

season_joinedstring

Filter by the season the user joined in, identified by season slug.

deleted'only' | 'included' | 'none'

Filter by deletion mode.

  • only - Show only deleted resources.
  • included - Include deleted resources.
  • none - Exclude deleted resources.
trashed'only' | 'all' | 'none'

Filter by soft-deletion mode.

  • only - Show only soft-deleted resources.
  • all - Include soft-deleted resources alongside live ones.
  • none - Exclude soft-deleted resources.
pagenumber

Specify the page number to return.

per_pagenumber

Limit the number of items returned to between 1 and 100.

If you provide a value outside this range, you will receive a 400 response.

order'confirmed_at' | 'created_at' | 'created_by' | 'email' | 'first_name' | 'last_name' | 'mobile' | 'name' | 'updated'

Column name to order by. An unrecognised value falls back to the default sort by updated.

dir'asc' | 'desc'

Sort in ascending or descending order.

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

x-api-languagestring[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Response

Users retrieved.

current_pageinteger

Number of the page returned by this response. The first page is 1.

first_page_urlstring

URL of the first page in the result set. Relative when the requested page is beyond the last page.

frominteger nullable

Position of the first record on this page within the full result set. The first record is at position 1. null when the requested page is beyond the last page.

last_pageinteger

Number of the last page. Equals the total number of pages.

last_page_urlstring

URL of the last page in the result set. Relative when the requested page is beyond the last page.

next_page_urlstring

URL of the next page in the result set.

Empty string when the current page is the last page.

pathstring

Canonical URL of the endpoint, without query parameters.

per_pageinteger

Maximum number of records returned per page.

prev_page_urlstring

URL of the previous page in the result set.

Empty string when the current page is the first page.

tointeger nullable

Position of the last record on this page within the full result set. null when the requested page is beyond the last page.

totalinteger

Total number of records across all pages.

Example response

{
  "current_page": 1,
  "data": [
    {
      "analytics_cookies": true,
      "broadcast_emails": true,
      "comments": "",
      "confirmation": "Confirmed",
      "confirmed_at": "2025-08-05T00:00:00Z",
      "created_at": "2025-08-05T09:00:58Z",
      "created_by": "invited",
      "email": "john.doe@example.com",
      "first_name": "John",
      "language": {
        "code": "en_GB",
        "language": "English (United Kingdom)"
      },
      "last_name": "Doe",
      "marketing_cookies": true,
      "mobile": "",
      "name": "John Doe",
      "necessary_cookies": true,
      "notification_emails": true,
      "notification_sms": true,
      "roles": [
        {
          "slug": "AbCdEfGh",
          "link": "https://api.eu.staging.cr4ce.com/role/AbCdEfGh",
          "name": {
            "en_GB": "Entrant"
          }
        }
      ],
      "slug": "KlMnOpQr",
      "updated": "2026-06-28T08:03:58Z"
    },
    {
      "analytics_cookies": false,
      "broadcast_emails": false,
      "comments": "",
      "confirmation": "Confirmed",
      "confirmed_at": "2025-04-01T00:00:00Z",
      "created_at": "2025-04-23T12:36:32Z",
      "created_by": "manual",
      "email": "jane.roe@example.com",
      "first_name": "Jane",
      "language": {
        "code": "en_GB",
        "language": "English (United Kingdom)"
      },
      "last_name": "Roe",
      "marketing_cookies": false,
      "mobile": "",
      "name": "Jane Roe",
      "necessary_cookies": true,
      "notification_emails": false,
      "notification_sms": false,
      "roles": [
        {
          "slug": "AbCdEfGh",
          "link": "https://api.eu.staging.cr4ce.com/role/AbCdEfGh",
          "name": {
            "en_GB": "Entrant"
          }
        },
        {
          "slug": "CdEfGhIj",
          "link": "https://api.eu.staging.cr4ce.com/role/CdEfGhIj",
          "name": {
            "en_GB": "Program manager"
          }
        }
      ],
      "slug": "MnOpQrSt",
      "updated": "2026-06-25T15:39:46Z"
    }
  ],
  "first_page_url": "https://api.eu.staging.cr4ce.com/user?per_page=100&page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://api.eu.staging.cr4ce.com/user?per_page=100&page=5",
  "next_page_url": "https://api.eu.staging.cr4ce.com/user?per_page=100&page=2",
  "path": "https://api.eu.staging.cr4ce.com/user",
  "per_page": 100,
  "prev_page_url": "",
  "to": 100,
  "total": 470
}

Changes

  • v2e2511e46f9f2Revision changes
    • breaking

      for the query request parameter page, the type changed from string to number

    • breaking

      for the query request parameter per_page, the type changed from string to number

    • info

      the response's property default value 10 was added for the status (media type: application/json)

    • info

      the response's property default value 10 was added for the status (media type: application/xml)

  • v2a269ebb35abfRevision changes
    • breaking

      the response property / became nullable for the status (media type: application/json)

    • breaking

      the response property / became nullable for the status (media type: application/xml)

    • breaking

      the response property / became nullable for the status (media type: application/json)

    • breaking

      the response property / became nullable for the status (media type: application/xml)

    • breaking

      the / response's property format changed from uri to no format for status (media type: application/json)

    • breaking

      the / response's property format changed from uri to no format for status (media type: application/xml)

    • breaking

      the / response's property format changed from uri to no format for status (media type: application/json)

    • breaking

      the / response's property format changed from uri to no format for status (media type: application/xml)

    • breaking

      the / response's property format changed from uri to no format for status (media type: application/json)

    • breaking

      the / response's property format changed from uri to no format for status (media type: application/xml)