developer portal

Users

Every call needs a service key. Create one in Proof under Settings, Service keys, then send it as Authorization: Bearer sk_.... Without the scope for the call you get a 403.

The people in your environment who can be attached to a workplace group. Read-only over the public API.

Only active members are returned. Invited and deactivated memberships are left out, and so is the GeoDynamics support identity.

Get users

Returns a paged list of the active users in the key's environment, 100 per page.

Invited and deactivated memberships are left out, and so is the GeoDynamics support identity. What you get back is the set of people you can actually attach to a workplace group.

Query parameters

NameTypeRequiredExample
pageZero-based page index. Defaults to 0.integeroptional0

Responses

200OK
FieldType
itemsUsers on this page.array
filterPaging state for this query.object
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  ],
  "filter": {
    "page": 0,
    "pageSize": 100,
    "totalCount": 1,
    "sortAscending": true,
    "sortString": "",
    "searchString": ""
  }
}
401Unauthorized. Missing or invalid service key.
403Forbidden. The key lacks the required scope.