Viewer

Authentication: All endpoints require an Authorization: Bearer <access token> header.

Most endpoints require an X-Company-ID: <company_id> header to scope requests to a specific company. This is the recommended header for most API operations.

Some endpoints require an X-Location-ID: <location_id> header when the query doesn't accept a locationId parameter.

See Authentication for details on how to obtain and use these headers.

Query Viewer

Retrieve information about the authenticated user and the companies they have access to. This endpoint is useful for determining which companies and locations the current API user can access.

Query Parameters:

This query takes no parameters and returns information about the authenticated user.

Response Fields:

Field Description
user.id Unique identifier for the user
user.fullName Full name of the user
user.email Email address of the user
employees Array of employee records for this user across companies
employees[].company.id Unique identifier for the company
employees[].company.name Name of the company
employees[].location.id Unique identifier for the location
employees[].location.name Name of the location

Implementation Notes:

  • This endpoint does not require X-Company-ID or X-Location-ID headers
  • The response includes all companies and locations the authenticated user has access to
  • Each entry in the employees array represents an employee record for the user in a specific company/location
  • This is particularly useful for multi-company API integrations
  • Use the returned company IDs to make subsequent API calls with the appropriate X-Company-ID header
  • The same user can have access to multiple companies and locations
  • This endpoint is typically called first to discover available companies before making other API calls

GraphQL Query

query Viewer {
  viewer {
    user {
      id
      fullName
      email
    }
    employees {
      company {
        id
        name
      }
      location {
        id
        name
      }
    }
  }
}

Example Variables

{}

Example Response

{
  "data": {
    "viewer": {
      "user": {
        "id": "53350",
        "fullName": "Roubler Support",
        "email": "api_user@roubler.com"
      },
      "employees": [
        {
          "company": {
            "id": "4",
            "name": "Roubler UK"
          },
          "location": {
            "id": "6",
            "name": "Roubler UK"
          }
        },
        {
          "company": {
            "id": "10",
            "name": "Roubler Dev"
          },
          "location": {
            "id": "143",
            "name": "Roubler Dev"
          }
        },
        {
          "company": {
            "id": "999",
            "name": "Integration Sandbox"
          },
          "location": {
            "id": "12325",
            "name": "Integration Sandbox"
          }
        }
      ]
    }
  }
}