Me

Retrieve list of agencies with which the current client is associated

get/v1/me/agencies

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
      Scopesapi_agencies_read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Response

Agency information

idinteger nullable
namestring nullable
adminboolean nullable

True if this user is an admin of this agency

Changes

No recorded changes to this operation across all 18 revisions of this API.