Company

A Company is the legal entity operating under an Organization, identified by its registration number.

Retrieving Companies

Use the GET /v1/companies endpoint to retrieve a paginated list of companies associated with your authentication token. Both pageNumber and pageSize are required query parameters.

GET https://api.caspeco.com/api/organizations/v1/companies?pageNumber=0&pageSize=20
Authorization: Bearer YOUR_ACCESS_TOKEN

Response

The response contains a paginated list of companies:

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Example Company",
      "businessName": "Example Company AB",
      "companyRegistrationNumber": "556000-0000",
      "countryCode": "SE",
      "currencyCode": "SEK",
      "address": {
        "street": "Exempelgatan 1",
        "city": "Stockholm",
        "postalCode": "111 22"
      },
      "contact": {
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane.doe@example.com",
        "phone": "+46701234567"
      },
      "status": "Active",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "pageNumber": 0,
  "pageSize": 20,
  "totalItems": 1,
  "totalPages": 1
}

Retrieving a Single Company

Use the GET /v1/companies/{id} endpoint to retrieve a specific company by its ID:

GET https://api.caspeco.com/api/organizations/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6
Authorization: Bearer YOUR_ACCESS_TOKEN

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Example Company",
  "businessName": "Example Company AB",
  "companyRegistrationNumber": "556000-0000",
  "countryCode": "SE",
  "currencyCode": "SEK",
  "address": {
    "street": "Exempelgatan 1",
    "city": "Stockholm",
    "postalCode": "111 22"
  },
  "contact": {
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com",
    "phone": "+46701234567"
  },
  "status": "Active",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

API Reference

See the Company reference for full endpoint documentation.