DOdomain
Agencies

Retrieves summary of agency search.

Given a specified agency search criteria, this endpoint can be used to ascertain the result count that can be expected.

See X-Total-Count header for result count.

head/v1/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.

Query parameters

qstring

Search phrase. e.g. name:"Agency XYZ"

pageNumberinteger

Page number for paginated results

pageSizeinteger

Page size for paginated results

Response

No Content

Changes

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