GET/directory/employment-types/external-keys

Gets a list of employment type external keys.

Caution
Support for this API operation is scheduled to end. Please use Get user type external keys.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/employment-types/external-keys

Query Parameters

ParameterTypeDescription
domainId integer 

Domain ID


example : 10000001
format : int32 
count integer 

Number of items to get


default : 100
minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

Cursor


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
hasExternalKey boolean 

Gets resources based on whether they have external keys.

  • true: Gets the resources which have external keys.
  • false: Gets the resources which do not have external keys.
  • If not specified, it gets all resources.

example : false 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
employmentTypes array (DomainUniqueExternalKeyResponse) 

Employment type information

 
responseMetaData object (responseMetaData) 

Response metadata

 

DomainUniqueExternalKeyResponse

PropertyTypeDescription
domainId integer 

Domain ID


format : int32
readOnly : true 
name string 

First name


readOnly : true 
id string 

ID.

It is the ID automatically assigned to a resource.


readOnly : true 
externalKey string 

Customer's external key.


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "employmentTypes": [3    {4      "domainId": 10000001,5      "name": "name01",6      "id": "employ2c-f321-47a6-ac11-e81fcc23a8c3",7      "externalKey": "EMPLOYMENTTYPE_EXT_01"8    },9    {10      "domainId": 10000001,11      "name": "name02",12      "id": "employ0f-997b-4f47-9267-463f15e908a3",13      "externalKey": "EMPLOYMENTTYPE_EXT_02"14    }15  ],16  "responseMetaData": {17    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="18  }19}