/v1/companies
GET
/v1/companies
const url = 'https://api.caspeco.com/api/organizations/v1/companies?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?pageNumber=1&pageSize=1'Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”pageNumber
required
integer format: int32
pageSize
required
integer format: int32
Responses
Section titled “Responses”OK
object
items
required
Array<object>
object
id
required
string format: uuid
name
required
string
businessName
required
string
companyRegistrationNumber
required
string
countryCode
required
string
currencyCode
required
string
address
required
object
street
string
city
string
postalCode
string
locationIds
required
Array<string>
status
required
string
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
id
required
string format: uuid
name
required
string
businessName
required
string
companyRegistrationNumber
required
string
countryCode
required
string
currencyCode
required
string
address
required
object
street
string
city
string
postalCode
string
locationIds
required
Array<string>
status
required
string
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
id
required
string format: uuid
name
required
string
businessName
required
string
companyRegistrationNumber
required
string
countryCode
required
string
currencyCode
required
string
address
required
object
street
string
city
string
postalCode
string
locationIds
required
Array<string>
status
required
string
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" } ]}