Skip to main content
GET
/
v1
/
responsiblePersons
Query Responsible Persons
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/responsiblePersons \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "Id": 123,
    "Number": "<string>",
    "Description": "<string>",
    "Address": {
      "Id": 123,
      "Company": "<string>",
      "Company2": "<string>",
      "FormOfAddress": "<string>",
      "Title": "<string>",
      "FirstName": "<string>",
      "LastName": "<string>",
      "Street": "<string>",
      "Address2": "<string>",
      "PostalCode": "<string>",
      "City": "<string>",
      "State": "<string>",
      "CountryIso": "<string>",
      "VatID": "<string>",
      "PhoneNumber": "<string>",
      "MobilePhoneNumber": "<string>",
      "EmailAddress": "<string>",
      "Fax": "<string>"
    },
    "Created": "2023-11-07T05:31:56Z",
    "LastChanged": "2023-11-07T05:31:56Z",
    "IsActive": true,
    "LanguageKey": 123
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Response

Returns all ResponsiblePerson.

​
Id
integer<int32>
required

Unique ID to identify a Contact.

​
Number
string
required

Unique Number of the ResponsiblePerson.

​
Description
string
required

Manufacturer description.

​
Address
object
required

The customer's default address.

​
Created
string<date-time>
required

The DateTime of Creation.

​
LastChanged
string<date-time>
required

The DateTime of the Lastchange.

​
IsActive
boolean
required

The ResponsiblePerson is active

​
LanguageKey
integer<int32>
required

The Default Language of the ResponsiblePerson