Sign in
latestOpenAPI 3.1.02026-08-1014497184.0 KB

8b99dca11019

List all users

Lists all users in the project.

get/users

Query parameters

limitinteger

defines the maximum number of items to return per page (default: 50)

starting_afterstring

a cursor for use in pagination, points to the last ID in previous page

ending_beforestring

a cursor for use in pagination, points to the first ID in next page

querystring

filter users by their email address or external ID

Response

OK

Example response

{
  "data": [
    {
      "custom_attributes": {
        "key": "value"
      },
      "email": "dan@example.com",
      "external_id": "external-id",
      "first_name": "Dan",
      "id": "8a038704-acc1-47f9-81b0-7523886cbeae",
      "last_name": "Example"
    }
  ],
  "links": {
    "first": "https://api.magicbell.com/v1/example",
    "next": "https://api.magicbell.com/v1/example?page_next=abc",
    "prev": null
  }
}