Users

List users

List user records. Results are paginated.

get/v1/users

Request

  • Base URL
    https://api.capacity.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-capacity-id
    • or HTTP bearer

Query parameters

pageinteger

Result page number

limitinteger

Number of results per page

emailstring

Retrieve record for specific user by email

include_deactivated_usersunknown

If true, include deactivated users in the response

Response

An array of user objects

bodyobject

Json body data in the request

limitinteger

Number of results returned

pageinteger

Page of results returned

parametersobject

Query parameters in the request

Changes

No recorded changes to this operation across all 1 revision of this API.