/v1/companies/{id}/locations

GET

const url = 'https://api.caspeco.com/api/organizations/v1/companies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/locations?pageNumber=1&pageSize=1';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.caspeco.com/api/organizations/v1/companies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/locations?pageNumber=1&pageSize=1'

Parameters

Path Parameters

required

string format: uuid

Query Parameters

pageNumber

required

integer format: int32

<= 500

pageSize

required

integer format: int32

>= 1 <= 500

Responses

200

object

items

required

Array<object>

object

required

string format: uuid

name

required

string

address

required

object

street

required

string

city

required

string

postalCode

required

string

coordinates

required

object

latitude

required

number format: double

longitude

required

number format: double

countryCode

required

string

timeZone

required

string

locale

required

string

companyId

required

string format: uuid

costCenters

required

Array<object>

object

name

string

nullable

number

string

nullable

status

required

string

Allowed values: Undefined Onboarding Active Paused Offboarding

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

pageNumber

required

integer format: int32

pageSize

required

integer format: int32

totalItems

required

integer format: int32

totalPages

required

integer format: int32

object

items

required

Array<object>

object

required

string format: uuid

name

required

string

address

required

object

street

required

string

city

required

string

postalCode

required

string

coordinates

required

object

latitude

required

number format: double

longitude

required

number format: double

countryCode

required

string

timeZone

required

string

locale

required

string

companyId

required

string format: uuid

costCenters

required

Array<object>

object

name

string

nullable

number

string

nullable

status

required

string

Allowed values: Undefined Onboarding Active Paused Offboarding

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

pageNumber

required

integer format: int32

pageSize

required

integer format: int32

totalItems

required

integer format: int32

totalPages

required

integer format: int32

Example

{
  "items": [
    {
      "status": "Undefined"
    }
  ]
}

object

items

required

Array<object>

object

required

string format: uuid

name

required

string

address

required

object

street

required

string

city

required

string

postalCode

required

string

coordinates

required

object

latitude

required

number format: double

longitude

required

number format: double

countryCode

required

string

timeZone

required

string

locale

required

string

companyId

required

string format: uuid

costCenters

required

Array<object>

object

name

string

nullable

number

string

nullable

status

required

string

Allowed values: Undefined Onboarding Active Paused Offboarding

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

pageNumber

required

integer format: int32

pageSize

required

integer format: int32

totalItems

required

integer format: int32

totalPages

required

integer format: int32

Example

{
  "items": [
    {
      "status": "Undefined"
    }
  ]
}