Get contractor employees

This method allows you to down­load part­ner employes

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ext/partners-api/v1/partners/{partnerId}/employees
  • Http Method: GET

Headers

  • Accept: application/json
  • Con­tent-type: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Authorization and access

Autho­riza­tion process is described here. Each API request must also con­sist of unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Response example

{
  "_embedded": [
    {
      "department": {
        "id": "custom-department",
        "name": "custom-department",
        "name_native": null
      },
      "email": "test1@trans.eu",
      "family_name": "Kierowca",
      "foreign_languages": [],
      "given_name": "Jan",
      "job_title": "innre",
      "last_login_date": "2020-09-15T13:19:06.000Z",
      "mobile_telephone": "(0048) 2222222222",
      "registration_date": "2020-07-22T08:21:36.000Z",
      "telephone": "(0048) 12345678",
      "trans_id": "1111111-1"
    },
    {
      "department": {
        "id": "custom-department",
        "name": "",
        "name_native": null
      },
      "email": "test2@trans.eu",
      "family_name": "Nowak",
      "foreign_languages": [],
      "given_name": "Testowy",
      "job_title": "",
      "last_login_date": "2020-12-17T10:42:56.000Z",
      "mobile_telephone": "(0048) 7329013",
      "registration_date": "2020-12-17T10:36:55.000Z",
      "telephone": "(0048) 111111111",
      "trans_id": "1111111-2"
    },
    {
      "department": {
        "id": "custom-department",
        "name": "custom-department",
        "name_native": null
      },
      "email": "test3@trans.eu",
      "family_name": "Testowa",
      "foreign_languages": [],
      "given_name": "Anna",
      "job_title": "fbbb",
      "last_login_date": null,
      "mobile_telephone": null,
      "registration_date": "2021-06-14T13:25:22.000Z",
      "telephone": null,
      "trans_id": "11111111-3"
    }
  ],
  "page": 1,
  "page_count": 1,
  "page_size": 3,
  "total_items": 3
}

Paging

When call­ing GET method, page should be added as para­me­ter in the URL, for exam­ple:

GET https://api.platform.trans.eu/ext/partners-api/v1/partners/{partnerId}/employees?page=4