Skip to main content

Get All Accounts

GET 

/v2/accounts

Use this endpoint to Get all accounts.

You can use pagination with this resource. For more information, see pagination.

Filtering

The following operators and attributes are available for filtering accounts:

AttributeTypeOperatorsExample
namestring
  • eq
  • like
like(name,*swan*)
legal_namestring
  • eq
  • like
like(legal_name,*swan*)
registration_idstring
  • eq
  • like
like(registration_id,00000000-0000-1000-8000-*)
external_refstring
  • eq
  • like
like(external_ref,16be*)
idstring
  • eq
  • ge
  • gt
  • le
  • lt
  • in
in(id,"99248259-feea-40c6-b855-f719ee87a539", "363e4505-a2bb-4bc1-b667-2cc9a4de8668")
created_atstring
  • eq
  • ge
  • gt
  • le
  • lt
gt(created_at,"2021-06-02T18:44:07.617Z")
updated_atstring
  • eq
  • ge
  • gt
  • le
  • lt
ge(updated_at,"2021-06-07T18:24:48.149Z")

Request

Query Parameters

    filter string

    Specifies the filter attributes.

    page[limit] int64

    The number of records per page.

    page[offset] int64

    Possible values: <= 10000

    The number of records to offset the results by.

    sort string

    Supported attributes are created_at, email, id, name, or updated_at. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with -, for example, -updated_at. The default sort order is created_at in descending order. For more information, see Sorting.

Responses

OK

Schema
    data object[]
    meta object
    page object
    limit integer

    The maximum number of records per page for this response. You can set this value up to 100.

    current integer

    The current page.

    offset integer

    The current offset by number of records, not pages. Offset is zero-based.

    total integer

    The total page count.

    results object
    total integer

    The total number of results after applying filters, if any, or all results.

    links object
    current uri

    Always the current page.

    first uri

    Always the first page.

    last uri

    Always null if there is only one page.

    next string

    Always null if there is only one page.

    prev string

    Always null if the user is on the first page.

Loading...