Accounts

Allows you to see information about the corresponding account(s) related to a given API key or Organization, such as the company name and address.

:::info This endpoint does not require you to pass in the Account-Token header. When not using an Organization Token, the API key must be passed in via the Authorization header as this API key is what is used to lookup the associated accounts.

If this endpoint is authenticated using an Organization Token, all owner account memberships for accounts associated with the organization will be returned. :::

get/accounts

Request

Query parameters

start_cursorstring

The start cursor for Keyset pagination.

per_pageinteger

The number of records per page to return.

The fields, operations, and values to filter the records by.

id'asc' | 'desc'
created_at'asc' | 'desc'
updated_at'asc' | 'desc'

The fields and direction to sort the results by.

Response

OK

start_cursorstring nullable

The current start cursor of the records returned.

next_cursorstring nullable

The next cursor to retrieve the next page of records.

per_pageinteger

The maximum number of records returned.

estimated_remaining_countinteger

The number of remaining records including the returned records, up to a maximum of 500.

Example response

{
  "records": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "go_session_timeout_minutes": "60"
    }
  ]
}

Changes

    • warning

      added the new vendor_partner enum value to the // response property for the response status

    • info

      for the query request parameter per_page, the min was decreased from 2.00 to 1.00

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status