List company offices

Request

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947

Bodyapplication/jsonrequired

searchTextstring

Search text

paginationParamsobject(OffsetBasedPaginationRequestParams)required

Pagination information.

sortParamsobject(OfficeSortParams)

Sorting related parameters.

filtersArray of objects(ListOfficeFilter)

List of filters. Offices matching with any of filters would be returned.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/office-list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchText": "string",
    "paginationParams": {
      "offset": 0,
      "limit": 100
    },
    "sortParams": {
      "sortBy": "NAME",
      "sortOrder": "DESC"
    },
    "filters": [
      {
        "countries": [
          "US",
          "IN"
        ],
        "officeIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "externalIds": [
          "string"
        ],
        "legalEntityIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json

officesArray of objects(OfficeNode)required

List of Offices.

paginationParamsobject(PaginationResponseParams)required

Pagination parameters for response.

Response

{
  "offices": [
    { … }
  ],
  "paginationParams": {
    "totalNumResults": 0
  }
}