/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

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

businessName

required

string

companyRegistrationNumber

required

string

countryCode

required

string

currencyCode

required

string

address

required

object

street

string

nullable

city

string

nullable

postalCode

string

nullable

contact

required

object

firstName

required

string

lastName

required

string

email

string

nullable

phone

string

nullable

status

required

string

Allowed values: Undefined Onboarding Offboarding Paused Active Readonly Locked

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

businessName

required

string

companyRegistrationNumber

required

string

countryCode

required

string

currencyCode

required

string

address

required

object

street

string

nullable

city

string

nullable

postalCode

string

nullable

contact

required

object

firstName

required

string

lastName

required

string

email

string

nullable

phone

string

nullable

status

required

string

Allowed values: Undefined Onboarding Offboarding Paused Active Readonly Locked

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

businessName

required

string

companyRegistrationNumber

required

string

countryCode

required

string

currencyCode

required

string

address

required

object

street

string

nullable

city

string

nullable

postalCode

string

nullable

contact

required

object

firstName

required

string

lastName

required

string

email

string

nullable

phone

string

nullable

status

required

string

Allowed values: Undefined Onboarding Offboarding Paused Active Readonly Locked

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"
    }
  ]
}