GET /companies — loopay-api

v1

latestOpenAPI 3.0.02026-08-043111167.0 KB

Company

Get companies

Get all companies available where the user is associated

get/companies

Query parameters

authorizationstring required

Authorization token

Response

Array of Company model instances

idnumber

namestring

countryIdnumber

documentNumberstring

documentTypeIdnumber

stateCompanystring

stateStudyCompanystring

createdAtstring

updatedAtstring

isActiveboolean

Example response

[
  {
    "id": 1,
    "name": "Monsters Inc",
    "countryId": 1,
    "documentNumber": "123456789",
    "documentTypeId": 1,
    "stateCompany": "active",
    "stateStudyCompany": "active",
    "createdAt": "2021-03-01T00:00:00.000Z",
    "updatedAt": "2021-03-01T00:00:00.000Z",
    "isActive": true
  }
]