List Account Branches

get/accounts/{accountId}/branches

Returns an (optionally) filtered list of all branches in an account accessible to the authenticated user.

Scope: read:accounts:referencedata

Request

Path Parameters

NameTypeRequiredExampleDescription
accountIdstringrequired4eb62cb48c9f429c93bc26664c1a5a4d

Unique identifier of an account.

Query String Parameters

NameTypeRequiredExampleDescription
filterstringoptionalname:Scottie*

Filter results using ElasticSearch Query Syntax.

sortarrayoptionalsort=name:asc&sort=type:desc

To sort the results by either ascending or descending order

firstintegeroptional100

Pagination: Indicates the number of items per page (when After cursor is used)

afterstringoptional342dfs09ds329320

Pagination: Return objects after this cursor

lastintegeroptional100

Pagination: Indicates the number of items per page (when Before cursor is used)

beforestringoptional531dfs09ds332932

Pagination: Return objects before this cursor

Responses

The request was successful, the response contains an an array of branches (in summary form) in the account, wrapped in pagination information.
© 2022 enableHR · All rights reserved