⌘K
GET /users
Returns a paginated list of the users belonging to your account.
Base URL: https://api.geocerta.io
Sandbox URL: https://api-staging.geocerta.io
Authentication required. Include your API key in the
api-keyheader. See Authentication.
Endpoint
GET /users
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | number | No | Page number (default: 1) |
per_page | number | No | Results per page (default: 20) |
name | string | No | Filter by name |
email | string | No | Filter by email |
role | string | No | Filter by role: account_owner or user |
Response
200 OK — returns a paginated list of users.
Response fields
| Field | Type | Description |
|---|---|---|
results[]._id | string | User ID |
results[].name | string | User display name |
results[].email | string | User email address |
results[].role | string | User role: account_owner or user |
results[].account.id | string | Linked account ID (if any) |
results[].account.name | string | Linked account name (if any) |
pagination.total | number | Total number of results |
pagination.page | number | Current page |
pagination.per_page | number | Results per page |
pagination.pages | number | Total number of pages |
Errors
| Status | Message | Cause |
|---|---|---|
401 | Unauthorized | Missing or invalid API key |
403 | Forbidden | API key is not linked to an account |
Example
curl "https://api.geocerta.io/users?page=1&per_page=20" \
-H "api-key: YOUR_API_KEY"