Headers
-
X-Correlation-Id string
Unique identifier to allow referencing a particular transaction or event chain
Minimum length is
1
. -
Accept-Language string
Returns the requested resources translated according to the passed languages (see translatable resources)
Minimum length is
1
.
Query parameters
-
id array[string]
ID(s) to be considered for filtering
At least
1
element. Minimum length of each is1
. -
external-id array[string]
External ID(s) to be considered for filtering
At least
1
element. Minimum length of each is1
, maximum length of each is255
. -
active boolean
Status to be considered for filtering
-
virtual boolean
Type to be considered for filtering
-
employee-id array[string]
Related employee ID(s) to be considered for filtering
At least
1
element. Minimum length of each is1
. -
employee-external-id array[string]
Related employee external ID(s) to be considered for filtering
At least
1
element. Minimum length of each is1
, maximum length of each is255
. -
employee-relation-role array[string]
Related employee relation role(s) to be considered for filtering
At least
1
element. Values areAGENT
orOFFICE_MANAGER
. -
offset string(positive-integer)
Offset for the results to be returned
Default value is
0
. -
limit string(positive-integer)
Limitation for the number of results to be returned
Default value is
25
. -
with-deleted boolean
Includes deleted resources in the results
curl \
-X GET https://api.development.pexipengage.com/enterprises/acme/offices \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
-H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
-H "Accept-Language: en *"
{
"data": [
{
"id": "123",
"name": {
"language": "en",
"value": "Lorem ipsum"
},
"description": {
"language": "en",
"value": "Lorem ipsum"
},
"directions": {
"language": "en",
"value": "Lorem ipsum"
},
"parkingInfo": {
"language": "en",
"value": "Lorem ipsum"
},
"email": "john.doe@pexip.com",
"externalId": "ABCD1234",
"phoneNumber": "+32412345678",
"active": true,
"virtual": true,
"timeZone": "Europe/Brussels",
"usesIndependentAgents": true,
"meetingRooms": [
{
"id": "123"
}
],
"employeeRelations": [
{
"role": "AGENT",
"employee": {
"id": "123"
}
}
],
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z",
"deletedAt": "2022-08-17T19:05:21.362Z",
"location": {
"city": {
"language": "en",
"value": "Lorem ipsum"
},
"state": {
"language": "en",
"value": "Lorem ipsum"
},
"street1": {
"language": "en",
"value": "Lorem ipsum"
},
"street2": {
"language": "en",
"value": "Lorem ipsum"
},
"postalCode": "9000",
"countryCode": "BE",
"formattedAddress": "string",
"geolocation": {
"latitude": 51.0479466,
"longitude": 3.6912248
}
}
}
],
"meta": {
"offset": 0,
"limit": 25,
"totalCount": 42
}
}