v1

latestOpenAPI 3.0.02026-08-043111167.0 KB
Affiliate

Get all affiliates

Gets all affiliates created by the currently registered user, belonging to the company of the user

get/affiliates

Query parameters

authorizationstring required

Authorization token

adminIdstring required

id of the current Affiliate company admin user

Response

Array of Affiliate model instances

idinteger
namestring
documentTypeIdinteger
documentNumberstring
isActiveboolean
stateCompanystring
stateStudyCompanystring
countryIdinteger
createdAtstring

Example response

[
  {
    "id": 1,
    "name": "John Doe Inc",
    "documentTypeId": 1,
    "documentNumber": "900200001",
    "isActive": true,
    "stateCompany": "initial",
    "stateStudyCompany": "missInfo",
    "countryId": 1,
    "createdAt": "2020-10-28T15:33:19.000Z",
    "companyUser": [
      {
        "id": 1,
        "role": "admin",
        "user": {
          "id": 1,
          "name": "John Doe",
          "email": "johnDoe@doeInc.com",
          "phone": "+1234567890",
          "createdAt": "2020-10-28T15:33:19.000Z",
          "updatedAt": "2020-10-28T15:33:19.000Z"
        }
      }
    ]
  }
]