List Organization Nodes

GET https://{{axpAPIDomain}}/api/admin/account/v1/accounts/:accountId/organization-nodes?pageNumber=2&children=false&pageSize=5&filter=name:LocationPune&orderBy=name

This API requires the Account Administrator role.

Lists the organization nodes for an account.

Request Params

The possible fields you can filter are:

• name
• accountId

The allowed format:

• Begins with the column name to be filtered, followed by a colon, (This will be used as Contains operator.) then:
  • Either an exact string to match, or
  • A string expression including the * wildcard character.
    • :{PREFIX}* will be used to find out word start with.
    • :*{POSTFIX} will be used to find out word end with
    • : will be used to match exact word
• Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string) | | orderBy | string | | Field name on which sorting needs to be performed.

The possible fields you ordered on

• name
• accountId

Field Names are case-sensitive (should be written as it is in description).

The default sorting order is name ascending.

To specify descending order, a suffix "desc" should be added. For example, "name" for ascending or "name desc" for descending". |

HEADERS

RESPONSES

status: OK

{"pagination":{"pageNumber":2,"pageSize":10,"total":45},"organizationNodes":[{"name":"Location","parentPath":"AccountA","organizationNodeId":"ACDSFE","url":"/api/admin/account/v1/accounts/accountA-id/organization-nodes/accountA-location1-id","nodeType":"OrganizationNode","countryCode":"IN"}],"links":{"prev":"/api/admin/account/v1/accounts/accountId/organization-nodes?pageNumber=1\u0026pageSize=10","next":"/api/admin/account/v1/accounts/accountId/organization-nodes?pageNumber=3\u0026pageSize=10"}}