Skip to main content
GET
/
api
/
users
Error
A valid request URL is required to generate request examples
{
  "hydra:member": [
    {
      "@id": "<string>",
      "@type": "<string>",
      "email": "jsmith@example.com",
      "@context": "<string>",
      "id": "<string>",
      "password_set_at": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "last_name": "<string>",
      "enabled": true,
      "last_login": "2023-11-07T05:31:56Z",
      "api_key": "<string>",
      "roles": [
        "<string>"
      ],
      "utm_tags": [
        "<string>"
      ],
      "bento_hash": "<string>",
      "intercom_hash": "<string>",
      "is_subscription_expired": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "default_team": {
        "@id": "<string>",
        "@type": "<string>",
        "name": "<string>",
        "@context": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "owner_email": "<string>",
        "last_activity_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "hydra:totalItems": 1,
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  },
  "hydra:view": {
    "@id": "string",
    "@type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  }
}

Authorizations

​
api-key
string
header
required

Value for the api-key header parameter.

Query Parameters

​
page
integer
default:1

The collection page number

​
itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 30
​
email
string

Response

User collection

User.jsonld-user.read_team.restricted_payment.read_subscription.read_consumption.read_last_activity.read_plan.read_topup.read_auto_topup_setting.read collection.

​
hydra:member
object[]
required
​
hydra:totalItems
integer
Required range: x >= 0
​
hydra:search
object
​
hydra:view
object
Example:
{
  "@id": "string",
  "@type": "string",
  "hydra:first": "string",
  "hydra:last": "string",
  "hydra:previous": "string",
  "hydra:next": "string"
}