In this article, you can read about how to retrieve attribute IDs for companies, contact persons, projects and candidates.

List Attributes

Adding attributes to candidates, companies, contact persons, and projects requires an attributeId. To obtain these attribute IDs, you first have to do a GET request for the selected attribute scope using the requests below.

Note

Creating a new attribute must be done within the system by an administrator.

Get Company Attributes

GET

https://api.recman.io/v2/get/?
key={{api_key}}&scope=companyAttribute

PARAMS

key{{api_key}} 
required
scopecompanyAttribute
required

Get Company Contact Attribute Scope

GET

https://api.recman.io/v2/get/?
key={{api_key}}&scope=companyContactAttribute

PARAMS

key{{api_key}} 
required
scopecompanyContactAttribute
required

Get Project Attribute Scope

GET

https://api.recman.io/v2/get/?
key={{api_key}}&scope=projectAttribute

PARAMS

key{{api_key}} 
required
scopeprojectAttribute
required
page1

Get Candidate Attribute Scope

GET

https://api.recman.io/v2/get/?key={{api_key}}
&scope=candidateAttribute&withTranslations=true

For retrieving attribute translations, please specify the query parameterwithTranslations=true.

Language codes in the response are specified in the ISO 639-1 standard.

PARAMS

key{{api_key}} 
required
scopecandidateAttribute
required, string
withTranslationstrue
optional, boolean (true/false)
Was this article helpful?
0 out of 0 found this helpful