Skip to main content
GET
/
users
/
List users
curl --request GET \
  --url https://dashboard.hologram.io/api/1/users/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 123,
  "size": 123,
  "continues": true,
  "lastid": 123,
  "data": [
    {
      "id": 123,
      "email": "jsmith@example.com",
      "first": "<string>",
      "last": "<string>",
      "role": "<string>",
      "partnerid": 123,
      "registered": "2023-11-07T05:31:56Z",
      "defaultaddressid": 123,
      "personal_org": 123,
      "impersonated_by": {}
    }
  ],
  "links": {
    "path": "<string>",
    "base": "<string>",
    "next": "<string>"
  }
}

Authorizations

Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

limit
integer

Maximum number of results to return

before
integer

Return records with ID less than this value (cursor-based pagination)

after
integer

Return records with ID greater than this value (cursor-based pagination)

userid
integer

Filter to return a specific user by ID

Response

OK

success
boolean

Indicates whether the request was successful.

Example:

true

limit
integer
size
integer
continues
boolean
lastid
integer
data
object[]