Profile APIs (v1)

Download OpenAPI specification:Download

Support: [email protected] URL: https://github.com/aircampi Terms of Service

Introduction

Profiles are widely used by organizations to describe the attributes of jobs or individuals. Typically, profiles summarize the competencies, qualifications, and skills of any type of objects. Profiles are valuable for tracking persons' skills, competencies, and accomplishments, in career planning, for identifying training needs, for performance management, and in the recruitment process for identifying job requirements and suitable applicants.

Quick Links:

Data Model

The data model of the Profile APIs is represented by the following conceptual model. This will make it easier for you to understand the Profile APIs.

Click to enlarge the image.

Endpoints

Profile APIs Endpoints.

Server Health

Server Health for Profile APIs

Check Health

Responses

Response samples

Content type

application/json

{"server_name": "Profile APIs",
"server_version": "v1",
"server_status": "Active",
"server_description": "API Server for Hischool Profile"
}

Server Settings

Server Settings for Profile APIs

Get Server Settings

Get a server settings.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{ }

Update Server Settings

Update a server settings. Updates all fields in a settings.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Server Settings

object (server_settings)

Server Settings

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{ }

Patch Server Settings

Patch a server settings. Updates one or more fields in a settings. The operation updates passed fields only.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Server Settings

object (server_settings)

Server Settings

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{ }

Profiles

Every user and candidate has a profile. It includes personal information like firstname, lastname, image, and social accounts, educations, experiences, skills and attachments.

Built-in Content Types:

Names
Images
Emails
Phones
Webs
Socials
Addresses
Educations
Languages
Skills
Experiences
Attachments

Custom Content Type:

Profile Contents

Get Profiles

Returns a list of profiles that the requesting user is permitted to view.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"names": 0,
"images": 0,
"emails": 0,
"phones": 0,
"webs": 0,
"socials": 0,
"addresses": 0,
"educations": 0,
"languages": 0,
"skills": 0,
"experiences": 0,
"attachments": 0,
"contents": 0,
"citizenships": 0,
"awards": 0,
"tests": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"names": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"images": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"phones": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"webs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"socials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"addresses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"educations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"languages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"writing_level_id": "proficiency",
"reading_level_id": "proficiency",
"listening_level_id": "proficiency",
"speaking_level_id": "proficiency",
"overall_level_id": "proficiency",
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"skills": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"experiences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"contents": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"content_type_id": "location",
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"citizenships": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"awards": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tests": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Profile

Create a profile.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Profile

type_id required	string (Type Id) Profile Type Id
name required	string (Name) Profile Name
description	string (Description) Profile Description
	Array of objects (Profile Attributes) Profile Attributes. Must be passed required attributes defined on attribute of the profile type.
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time
	object (Profile Metadata) Profile Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"names": 0,
"images": 0,
"emails": 0,
"phones": 0,
"webs": 0,
"socials": 0,
"addresses": 0,
"educations": 0,
"languages": 0,
"skills": 0,
"experiences": 0,
"attachments": 0,
"contents": 0,
"citizenships": 0,
"awards": 0,
"tests": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"names": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"images": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"phones": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"webs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"socials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"addresses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"educations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"languages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"writing_level_id": "proficiency",
"reading_level_id": "proficiency",
"listening_level_id": "proficiency",
"speaking_level_id": "proficiency",
"overall_level_id": "proficiency",
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"skills": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"experiences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"contents": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"content_type_id": "location",
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"citizenships": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"awards": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tests": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Profile

Retrieve a single profile details.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"names": 0,
"images": 0,
"emails": 0,
"phones": 0,
"webs": 0,
"socials": 0,
"addresses": 0,
"educations": 0,
"languages": 0,
"skills": 0,
"experiences": 0,
"attachments": 0,
"contents": 0,
"citizenships": 0,
"awards": 0,
"tests": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"names": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"images": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"phones": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"webs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"socials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"addresses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"educations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"languages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"writing_level_id": "proficiency",
"reading_level_id": "proficiency",
"listening_level_id": "proficiency",
"speaking_level_id": "proficiency",
"overall_level_id": "proficiency",
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"skills": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"experiences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"contents": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"content_type_id": "location",
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"citizenships": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"awards": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tests": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Profile

You can update fields of a profile after the profile is created. The following fields can be updated any time after the profile is created.

Available fields to update:

name
description
profile_metadata
app_metadata

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Profile

name	string (Name) Profile Name
description	string (Description) Profile Description
	Array of objects (Profile Attributes) Profile Attributes. Must be passed required attributes defined on attribute of the profile type.
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time
	object (Profile Metadata) Profile Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"names": 0,
"images": 0,
"emails": 0,
"phones": 0,
"webs": 0,
"socials": 0,
"addresses": 0,
"educations": 0,
"languages": 0,
"skills": 0,
"experiences": 0,
"attachments": 0,
"contents": 0,
"citizenships": 0,
"awards": 0,
"tests": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"names": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"images": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"phones": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"webs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"socials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"addresses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"educations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"languages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"writing_level_id": "proficiency",
"reading_level_id": "proficiency",
"listening_level_id": "proficiency",
"speaking_level_id": "proficiency",
"overall_level_id": "proficiency",
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"skills": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"experiences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"contents": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"content_type_id": "location",
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"citizenships": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"awards": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tests": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Profile

Updates one or more fields in a profile. The operation updates passed fields only.

Available fields to update:

name
description
profile_metadata
app_metadata

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Profile

name	string (Name) Profile Name
description	string (Description) Profile Description
	Array of objects (Profile Attributes) Profile Attributes. Must be passed required attributes defined on attribute of the profile type.
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time
	object (Profile Metadata) Profile Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"names": 0,
"images": 0,
"emails": 0,
"phones": 0,
"webs": 0,
"socials": 0,
"addresses": 0,
"educations": 0,
"languages": 0,
"skills": 0,
"experiences": 0,
"attachments": 0,
"contents": 0,
"citizenships": 0,
"awards": 0,
"tests": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"names": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"images": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"phones": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"webs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"socials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"addresses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"educations": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"languages": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"writing_level_id": "proficiency",
"reading_level_id": "proficiency",
"listening_level_id": "proficiency",
"speaking_level_id": "proficiency",
"overall_level_id": "proficiency",
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"skills": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"experiences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"attachments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"contents": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"content_type_id": "location",
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"citizenships": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"awards": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tests": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Profile

Delete a profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Override Profile

Merges a profile's profile. Copies data of the profile specified in the request body and overrides to the profile specified in the resource URL.

You must passed following data in the request body:

Profile Id - Required, The profile to be copied.
Allow Null Values - Default is false. If true, system override the profile specified in the resource URL with the profile specified in the request body without checking NULL value. Otherwise, system override the profile specified in the resource URL with the data is not empty only.
Options - Optional, System will override only passed data of the profile when options have provided. Otherwise, system will override all data of the profile to the candidata profile specified in the resource URL.

Available options:
- Profile - Only profile main data like name, description, ...etc.
- Names - Only names of the profile specified in the request body.
- Images - Only images of the profile specified in the request body.
- Emails - Only emails of the profile specified in the request body.
- Phones - Only phones of the profile specified in the request body.
- Webs - Only webs of the profile specified in the request body.
- Socials - Only social accounts of the profile specified in the request body.
- Addresses - Only addresses of the profile specified in the request body.
- Educations - Only education entries of the profile specified in the request body.
- Languages - Only languages of the profile specified in the request body.
- Skills - Only skills of the profile specified in the request body.
- Experiences - Only expriences of the profile specified in the request body.
- Attachments - Only attachments of the profile specified in the request body.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Override Profile

profile_id required	string <uuid> (Profile Id) Profile Id
allow_null_values	boolean (Allow NULL Values) Default: false Default is `false`. If true, system override the profile specified in the resource URL with the profile specified in the request body without checking NULL value. Otherwise, system override the profile specified in the resource URL with the data is not empty only.
options	Array of strings (Options) Optional, System will override only passed data of the profile when options have provided. Otherwise, system will override all data of the profile to the candidata profile specified in the resource URL. Available options: Profile - Only profile main data like name, description, ...etc. Names - Only names of the profile specified in the request body. Images - Only images of the profile specified in the request body. Emails - Only emails of the profile specified in the request body. Phones - Only phones of the profile specified in the request body. Webs - Only webs of the profile specified in the request body. Socials - Only social accounts of the profile specified in the request body. Addresses - Only addresses of the profile specified in the request body. Educations - Only education entries of the profile specified in the request body. Languages - Only languages of the profile specified in the request body. Skills - Only skills of the profile specified in the request body. Experiences - Only expriences of the profile specified in the request body. Attachments - Only attachments of the profile specified in the request body.

Responses

Request samples

Payload

Content type

application/json

{"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"allow_null_values": false,
"options": ["profile",
"names",
"images",
"emails",
"phones",
"webs",
"socials",
"addresses",
"educations",
"languages",
"skills",
"experiences",
"attachments"
]
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Names

Profile Names is a list of names for the profile.

Each entry contains the following fields:

Type - e.g: Full Name
Text - e.g: John Doe

Get Names

Returns a list of names of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Name

Create a name to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Name

type required	string (Name Type) Enum: "full_name" "first_name" "last_name" "middle_name" "family_name" "official_name" "nick_name" "user_name" Name Types: Full Name First Name Last Name Middle Name Family Name Official Name Nick Name User Name
text required	string (Text) Name Text for type
description	string (Description) Name Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Name

Retrieve a single name details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
name_id required	string <uuid> (Name Id) Name Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Name

You can update fields of a name after the name is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
name_id required	string <uuid> (Name Id) Name Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Name

type	string (Name Type) Enum: "full_name" "first_name" "last_name" "middle_name" "family_name" "official_name" "nick_name" "user_name" Name Types: Full Name First Name Last Name Middle Name Family Name Official Name Nick Name User Name
text	string (Text) Name Text for type
description	string (Description) Name Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Name

Updates one or more fields in a name. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
name_id required	string <uuid> (Name Id) Name Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Name

type	string (Name Type) Enum: "full_name" "first_name" "last_name" "middle_name" "family_name" "official_name" "nick_name" "user_name" Name Types: Full Name First Name Last Name Middle Name Family Name Official Name Nick Name User Name
text	string (Text) Name Text for type
description	string (Description) Name Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "full_name",
"text": "John Doe",
"description": "Full Name",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Name

Delete a name from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
name_id required	string <uuid> (Name Id) Name Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Images

Profile Images is a list of images for the profile.

Each entry contains the following fields:

Type - e.g: Profile
URL - e.g: htts://github.com/aircampi.png
description - e.g: GitHub Profile

Get Images

Returns a list of images of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Image

Create an image to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Image

type required	string (Image Type) Enum: "profile" "cover" Image Types: Profile Image Cover Image
url required	string <url> (Image) Image URL
description	string (Description) Image Description (Alt Text)
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Image

Retrieve a single image details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
image_id required	string <uuid> (Image Id) Image Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Image

You can update fields of an image after the image is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
image_id required	string <uuid> (Image Id) Image Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Image

type	string (Image Type) Enum: "profile" "cover" Image Types: Profile Image Cover Image
url	string <url> (Image) Image URL
description	string (Description) Image Description (Alt Text)
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Image

Updates one or more fields in an image. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
image_id required	string <uuid> (Image Id) Image Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Image

type	string (Image Type) Enum: "profile" "cover" Image Types: Profile Image Cover Image
url	string <url> (Image) Image URL
description	string (Description) Image Description (Alt Text)
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "profile",
"url": "https://www.github.com/aircampi.png",
"description": "GitHub Profile Image",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Image

Delete an image from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
image_id required	string <uuid> (Image Id) Image Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Emails

Profile Emails is a list of emails for the profile.

Each entry contains the following fields:

Type - e.g: Work
address - e.g: hello@aircampi.com
description - e.g: Hello Mail

Get Emails

Returns a list of emails of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Email

Create an email to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Email

type required	string (Email Type) Enum: "personal" "work" Email Types: Personal Work
address required	string (Address) Email Address
description	string (Description) Email Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Email

Retrieve a single email details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
email_id required	string <uuid> (Email Id) Email Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Email

You can update fields of an email after the email is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
email_id required	string <uuid> (Email Id) Email Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Email

type	string (Email Type) Enum: "personal" "work" Email Types: Personal Work
address	string (Address) Email Address
description	string (Description) Email Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Email

Updates one or more fields in an email. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
email_id required	string <uuid> (Email Id) Email Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Email

type	string (Email Type) Enum: "personal" "work" Email Types: Personal Work
address	string (Address) Email Address
description	string (Description) Email Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"address": "[email protected]",
"description": "Work Email",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Email

Delete an email from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
email_id required	string <uuid> (Email Id) Email Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Phones

Profile Phones is a list of phones for the profile.

Each entry contains the following fields:

Type - e.g: Work
Country - e.g: +976
number - e.g: 99112233
extension - e.g: 1
description - e.g: Work Phone

Get Phones

Returns a list of phones of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Phone

Create a phone to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Phone

type required	string (Phone Type) Enum: "home" "work" "mobile" "business" Phone Types: Home Work Mobile Business
country	string (Phone Country Code) Phone Country Code
number required	string (Phone Number) Phone Number
extension	string (Phone Extension) Phone Extension
description	string (Description) Phone Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Phone

Retrieve a single phone details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
phone_id required	string <uuid> (Phone Id) Phone Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Phone

You can update fields of a phone after the phone is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
phone_id required	string <uuid> (Phone Id) Phone Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Phone

type	string (Phone Type) Enum: "home" "work" "mobile" "business" Phone Types: Home Work Mobile Business
country	string (Phone Country Code) Phone Country Code
number	string (Phone Number) Phone Number
extension	string (Phone Extension) Phone Extension
description	string (Description) Phone Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Phone

Updates one or more fields in a phone. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
phone_id required	string <uuid> (Phone Id) Phone Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Phone

type	string (Phone Type) Enum: "home" "work" "mobile" "business" Phone Types: Home Work Mobile Business
country	string (Phone Country Code) Phone Country Code
number	string (Phone Number) Phone Number
extension	string (Phone Extension) Phone Extension
description	string (Description) Phone Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"primary": false,
"type": "work",
"country": "+976",
"number": 99112233,
"extension": 1,
"description": "Work Phone",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Phone

Delete a phone from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
phone_id required	string <uuid> (Phone Id) Phone Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Webs

Profile Webs is a list of webs for the profile.

Each entry contains the following fields:

Type - e.g: Personal
address - e.g: htts://github.com/aircampi
description - e.g: GitHub Profile

Get Webs

Returns a list of webs of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Web

Create a web to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Web

type required	string (Web Type) Enum: "Personal" "Work" Web Types: Personal Work
address	string <url> (Address) Web Address
description	string (Description) Web Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Web

Retrieve a single web details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
web_id required	string <uuid> (Web Id) Web Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Web

You can update fields of a web after the web is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
web_id required	string <uuid> (Web Id) Web Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Web

type	string (Web Type) Enum: "Personal" "Work" Web Types: Personal Work
address	string <url> (Address) Web Address
description	string (Description) Web Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Web

Updates one or more fields in a web. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
web_id required	string <uuid> (Web Id) Web Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Web

type	string (Web Type) Enum: "Personal" "Work" Web Types: Personal Work
address	string <url> (Address) Web Address
description	string (Description) Web Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "Work",
"address": "www.aircampi.com",
"description": "Work Web",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Web

Delete a web from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
web_id required	string <uuid> (Web Id) Web Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Socials

Profile Socials is a list of social accounts, and you can provide one social account url for each social network type.

Each entry contains the following fields:

Type - e.g: Facebook
Username - e.g: aircampi.com
URL - e.g: https://www.facebook.com/aircampi

Get Socials

Returns a list of socials of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Social

Create a social to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Social

type required	string (Social Type) Enum: "facebook" "linkedin" "twitter" "github" Social Types: Facebook LinkedIn Twitter and more...
username required	string (Username) Username
url	string <url> (URL) URL
description	string (Description) Social Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Social

Retrieve a single social details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
social_id required	string <uuid> (Social Id) Social Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Social

You can update fields of a social after the social is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
social_id required	string <uuid> (Social Id) Social Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Social

type	string (Social Type) Enum: "facebook" "linkedin" "twitter" "github" Social Types: Facebook LinkedIn Twitter and more...
username	string (Username) Username
url	string <url> (URL) URL
description	string (Description) Social Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Social

Updates one or more fields in a social. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
social_id required	string <uuid> (Social Id) Social Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Social

type	string (Social Type) Enum: "facebook" "linkedin" "twitter" "github" Social Types: Facebook LinkedIn Twitter and more...
username	string (Username) Username
url	string <url> (URL) URL
description	string (Description) Social Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "github",
"username": "aircampi.com",
"url": "https://www.facebook.com/aircampi",
"description": "Work Social",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Social

Delete a social from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
social_id required	string <uuid> (Social Id) Social Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Addresses

Profile Addresses is a list of addresses for the profile.

Each entry contains the following fields:

Type - e.g: Home Address
Country - e.g: United States
state - e.g:
zipcode - e.g:
City - e.g: Washington D.C
line_1 - e.g: bayanzurkh district
line_2 - e.g: Peace avenue
line_3 - e.g: Building III

Get Addresses

Returns a list of addresses of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Address

Create an address to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Address

type required	string (Address Type) Enum: "home" "work" "school" Address Types: Home Work School
country required	string (Country Code) Enum: "mn" "us" "ch" Country Code
state	string (State) State
zipcode	string (Zipcode) Zipcode
city	string (City) City
line_1	string (Address Line 1) Address Line 1
line_2	string (Address Line 2) Address Line 2
line_3	string (Address Line 3) Address Line 3
description	string (Description) Address Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Address

Retrieve a single address details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
address_id required	string <uuid> (Address Id) Address Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Address

You can update fields of an address after the address is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
address_id required	string <uuid> (Address Id) Address Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Address

type	string (Address Type) Enum: "home" "work" "school" Address Types: Home Work School
country	string (Country Code) Enum: "mn" "us" "ch" Country Code
state	string (State) State
zipcode	string (Zipcode) Zipcode
city	string (City) City
line_1	string (Address Line 1) Address Line 1
line_2	string (Address Line 2) Address Line 2
line_3	string (Address Line 3) Address Line 3
description	string (Description) Address Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Address

Updates one or more fields in an address. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
address_id required	string <uuid> (Address Id) Address Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Address

type	string (Address Type) Enum: "home" "work" "school" Address Types: Home Work School
country	string (Country Code) Enum: "mn" "us" "ch" Country Code
state	string (State) State
zipcode	string (Zipcode) Zipcode
city	string (City) City
line_1	string (Address Line 1) Address Line 1
line_2	string (Address Line 2) Address Line 2
line_3	string (Address Line 3) Address Line 3
description	string (Description) Address Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "work",
"country": "mn",
"state": null,
"zipcode": 97611,
"city": "Ulaanbaatar",
"line_1": "bayanzurkh district",
"line_2": "Peace avenue",
"line_3": "Building III",
"description": "Work Address",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Address

Delete an address from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
address_id required	string <uuid> (Address Id) Address Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Educations

Profile Educations is a list of education entries.

Each entry may contain the following fields:

School
Level
Degree
Field of Study
Start at
End at
Completed - True if still study there
Description

Get Educations

Returns a list of educations of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Education

Create an education to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Education

school required	string (School) School Name
level	string (Education Level) Value: "higher_education" Education Level
degree	string (Degree) Degree Name
field_of_study	string (Field of Study) Field of Study
start_at	string <date> (Start At) Started Date
end_at	string <date> (End At) End Date
completed	boolean (Completed) Default: false Completed
description	string (Description) Education Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Education

Retrieve a single education details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
education_id required	string <uuid> (Education Id) Education Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Education

You can update fields of an education after the education is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
education_id required	string <uuid> (Education Id) Education Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Education

school	string (School) School Name
level	string (Education Level) Value: "higher_education" Education Level
degree	string (Degree) Degree Name
field_of_study	string (Field of Study) Field of Study
start_at	string <date> (Start At) Started Date
end_at	string <date> (End At) End Date
completed	boolean (Completed) Default: false Completed
description	string (Description) Education Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Education

Updates one or more fields in an education. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
education_id required	string <uuid> (Education Id) Education Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Education

school	string (School) School Name
level	string (Education Level) Value: "higher_education" Education Level
degree	string (Degree) Degree Name
field_of_study	string (Field of Study) Field of Study
start_at	string <date> (Start At) Started Date
end_at	string <date> (End At) End Date
completed	boolean (Completed) Default: false Completed
description	string (Description) Education Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"school": "University of Pennsylvania",
"level": "higher_education",
"degree": "B.S.",
"field_of_study": "Marketing Communication & Economics",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"completed": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Education

Delete an education from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
education_id required	string <uuid> (Education Id) Education Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Languages

Profile Languages is a list of language skills for the profile.

Each entry contains the following fields:

Language
Native
Rating Scale
Writing Level
Reading Level
Listening Level
Speaking Level
Overall Level
Overall Score
Assessment At
Description

Get Languages

Returns a list of languages of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"rating_scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"writing_level_id": "proficiency",
"writing_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"reading_level_id": "proficiency",
"reading_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"listening_level_id": "proficiency",
"listening_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"speaking_level_id": "proficiency",
"speaking_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_level_id": "proficiency",
"overall_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Language

Create a language to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Language

language required	string (Language Code) Enum: "mn" "en" "ch" "ru" Language Code: Mongolian English Chinese and more...
native	boolean (Native) Default: false Native
rating_scale_id	string (Scale Id) Scale Id
writing_level_id	string (Level Id) Level Id
reading_level_id	string (Level Id) Level Id
listening_level_id	string (Level Id) Level Id
speaking_level_id	string (Level Id) Level Id
overall_level_id	string (Level Id) Level Id
assessment_at	string <date> (Assessment At) Assessment Date
description	string (Description) Language Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"writing_level_id": "proficiency",
"reading_level_id": "proficiency",
"listening_level_id": "proficiency",
"speaking_level_id": "proficiency",
"overall_level_id": "proficiency",
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"rating_scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"writing_level_id": "proficiency",
"writing_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"reading_level_id": "proficiency",
"reading_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"listening_level_id": "proficiency",
"listening_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"speaking_level_id": "proficiency",
"speaking_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_level_id": "proficiency",
"overall_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Language

Retrieve a single language details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
language_id required	string <uuid> (Language Id) Language Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"rating_scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"writing_level_id": "proficiency",
"writing_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"reading_level_id": "proficiency",
"reading_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"listening_level_id": "proficiency",
"listening_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"speaking_level_id": "proficiency",
"speaking_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_level_id": "proficiency",
"overall_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Language

You can update fields of a language after the language is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
language_id required	string <uuid> (Language Id) Language Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Language

language	string (Language Code) Enum: "mn" "en" "ch" "ru" Language Code: Mongolian English Chinese and more...
native	boolean (Native) Default: false Native
rating_scale_id	string (Scale Id) Scale Id
writing_level_id	string (Level Id) Level Id
reading_level_id	string (Level Id) Level Id
listening_level_id	string (Level Id) Level Id
speaking_level_id	string (Level Id) Level Id
overall_level_id	string (Level Id) Level Id
assessment_at	string <date> (Assessment At) Assessment Date
description	string (Description) Language Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"writing_level_id": "proficiency",
"reading_level_id": "proficiency",
"listening_level_id": "proficiency",
"speaking_level_id": "proficiency",
"overall_level_id": "proficiency",
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"rating_scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"writing_level_id": "proficiency",
"writing_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"reading_level_id": "proficiency",
"reading_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"listening_level_id": "proficiency",
"listening_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"speaking_level_id": "proficiency",
"speaking_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_level_id": "proficiency",
"overall_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Language

Updates one or more fields in a language. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
language_id required	string <uuid> (Language Id) Language Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Language

language	string (Language Code) Enum: "mn" "en" "ch" "ru" Language Code: Mongolian English Chinese and more...
native	boolean (Native) Default: false Native
rating_scale_id	string (Scale Id) Scale Id
writing_level_id	string (Level Id) Level Id
reading_level_id	string (Level Id) Level Id
listening_level_id	string (Level Id) Level Id
speaking_level_id	string (Level Id) Level Id
overall_level_id	string (Level Id) Level Id
assessment_at	string <date> (Assessment At) Assessment Date
description	string (Description) Language Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"writing_level_id": "proficiency",
"reading_level_id": "proficiency",
"listening_level_id": "proficiency",
"speaking_level_id": "proficiency",
"overall_level_id": "proficiency",
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"language": "mn",
"native": false,
"rating_scale_id": "language_skill",
"rating_scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"writing_level_id": "proficiency",
"writing_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"reading_level_id": "proficiency",
"reading_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"listening_level_id": "proficiency",
"listening_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"speaking_level_id": "proficiency",
"speaking_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_level_id": "proficiency",
"overall_level_data": {"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"overall_score": 8.5,
"assessment_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Language

Delete a language from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
language_id required	string <uuid> (Language Id) Language Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Skills

Profile Skill is a list of skills.

Get Skills

Returns a list of skills of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Skill

Create a skill to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Skill

name required	string (Name) Skill Name
description	string (Description) Skill Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Skill

Retrieve a single skill details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
skill_id required	string <uuid> (Skill Id) Skill Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Skill

You can update fields of a skill after the skill is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
skill_id required	string <uuid> (Skill Id) Skill Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Skill

name	string (Name) Skill Name
description	string (Description) Skill Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Skill

Updates one or more fields in a skill. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
skill_id required	string <uuid> (Skill Id) Skill Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Skill

name	string (Name) Skill Name
description	string (Description) Skill Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Problem Solving",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Skill

Delete a skill from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
skill_id required	string <uuid> (Skill Id) Skill Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Experiences

Profile Experiences is a list of employments.

Each entry may contain the following fields:

Title
Company
Industry
Start at
End at
Current - True if still works there
Description

Get Experiences

Returns a list of experiences of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Experience

Create an experience to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Experience

title required	string (Title) Job Title
company required	string (Company) Company Name
industry	string (Industry) Industry Name
start_at	string <date> (Start At) Started Date
end_at	string <date> (End At) End Date
current	boolean (Current) Default: false Is Current Job?
description	string (Description) Experience Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Experience

Retrieve a single experience details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
experience_id required	string <uuid> (Experience Id) Experience Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Experience

You can update fields of an experience after the experience is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
experience_id required	string <uuid> (Experience Id) Experience Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Experience

title	string (Title) Job Title
company	string (Company) Company Name
industry	string (Industry) Industry Name
start_at	string <date> (Start At) Started Date
end_at	string <date> (End At) End Date
current	boolean (Current) Default: false Is Current Job?
description	string (Description) Experience Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Experience

Updates one or more fields in an experience. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
experience_id required	string <uuid> (Experience Id) Experience Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Experience

title	string (Title) Job Title
company	string (Company) Company Name
industry	string (Industry) Industry Name
start_at	string <date> (Start At) Started Date
end_at	string <date> (End At) End Date
current	boolean (Current) Default: false Is Current Job?
description	string (Description) Experience Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"title": "Chief Operating Officer",
"company": "Zion, LLC",
"industry": "Technology",
"start_at": "2019-08-24",
"end_at": "2019-08-24",
"current": false,
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Experience

Delete an experience from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
experience_id required	string <uuid> (Experience Id) Experience Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Attachments

Profile Attachments is a list of attachments.

Get Attachments

Returns a list of attachments of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Attachment

Create an attachment to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Attachment

type required	string (Attachment Type) Enum: "file" "link" "note" Attachment Type. If you want to get the list of values progmatically, use the Lookups endpoints. Attachment Types: File - File Attachment Link - Link Attachment Note - Note Attachment
category	string (Attachment Category) Enum: "essay" "interview" "recommendation" "portfolio" "academic_summary" Attachment Categories: Essay Interview Portfolio Recommendation Academic Summary and more... If you want to get the list of values progmatically, use the Lookups endpoints.
name required	string (Name) Attachment Name
description	string (Description) Attachment Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Attachment

Retrieve a single attachment details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Attachment

You can update fields of an attachment after the attachment is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Attachment

category	string (Attachment Category) Enum: "essay" "interview" "recommendation" "portfolio" "academic_summary" Attachment Categories: Essay Interview Portfolio Recommendation Academic Summary and more... If you want to get the list of values progmatically, use the Lookups endpoints.
name	string (Name) Attachment Name
description	string (Description) Attachment Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Attachment

Updates one or more fields in an attachment. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Attachment

category	string (Attachment Category) Enum: "essay" "interview" "recommendation" "portfolio" "academic_summary" Attachment Categories: Essay Interview Portfolio Recommendation Academic Summary and more... If you want to get the list of values progmatically, use the Lookups endpoints.
name	string (Name) Attachment Name
description	string (Description) Attachment Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time
	File (object) or Link (object) or Note (object) (Attachment Metadata) Attachment Metadata. It depends on attachment type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "file",
"category": "essay",
"name": "Resume",
"description": "Resume for Job",
"verified": false,
"verified_at": null,
"metadata": {"file_id": "123-abc-456-def-789-ghi",
"file_name": "Resume.pdf",
"file_type": "pdf",
"file_size": 1024
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Attachment

Delete an attachment from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
attachment_id required	string <uuid> (Attachment Id) Attachment Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Citizenships

Profile Citizenship is a list of citizenship data.

Each entry may contain the following fields:

Country
Nation ID
Issued at
Expiry at
Description

Get Citizenships

Returns a list of citizenships of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Citizenship

Create a citizenship to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Citizenship

country required	string (Citizenship Country) Enum: "mn" "us" "ru" "cn" Citizenship Country
national_id required	integer (Citizenship National ID) Citizenship National ID
issued_at	string <date> (Issued At) Citizenship Issued Date
expiry_at	string <date> (Expiry At) Citizenship Expiry Date
description	string (Description) Citizenship Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Citizenship

Retrieve a single citizenship details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
citizenship_id required	string <uuid> (Citizenship Id) Citizenship Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Citizenship

You can update fields of a citizenship after the test is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
citizenship_id required	string <uuid> (Citizenship Id) Citizenship Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Citizenship

country	string (Citizenship Country) Enum: "mn" "us" "ru" "cn" Citizenship Country
national_id	integer (Citizenship National ID) Citizenship National ID
issued_at	string <date> (Issued At) Citizenship Issued Date
expiry_at	string <date> (Expiry At) Citizenship Expiry Date
description	string (Description) Citizenship Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Citizenship

Updates one or more fields in a citizenship. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
citizenship_id required	string <uuid> (Citizenship Id) Citizenship Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Citizenship

country	string (Citizenship Country) Enum: "mn" "us" "ru" "cn" Citizenship Country
national_id	integer (Citizenship National ID) Citizenship National ID
issued_at	string <date> (Issued At) Citizenship Issued Date
expiry_at	string <date> (Expiry At) Citizenship Expiry Date
description	string (Description) Citizenship Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"country": "mn",
"national_id": "abc-123-def",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Citizenship

Delete a citizenship from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
citizenship_id required	string <uuid> (Citizenship Id) Citizenship Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Tests

Profile Test is a list of test or exam data.

Each entry may contain the following fields:

Type
Score
Test at
Description

Get Tests

Returns a list of tests of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"components": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"components": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Test

Create a test to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Test

type required	string (Test/Exam Type) Enum: "ielts" "sat" "toefl" Test/Exam Type
score	integer (Test/Exam Score) Test/Exam Score
test_at	string <date> (Test/Exam At) Test/Exam Date
description	string (Description) Test/Exam Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"components": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"components": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Test

Retrieve a single test details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"components": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"components": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Test

You can update fields of a test after the test is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Test

type	string (Test/Exam Type) Enum: "ielts" "sat" "toefl" Test/Exam Type
score	integer (Test/Exam Score) Test/Exam Score
test_at	string <date> (Test/Exam At) Test/Exam Date
description	string (Description) Test/Exam Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"components": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"components": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Test

Updates one or more fields in a test. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Test

type	string (Test/Exam Type) Enum: "ielts" "sat" "toefl" Test/Exam Type
score	integer (Test/Exam Score) Test/Exam Score
test_at	string <date> (Test/Exam At) Test/Exam Date
description	string (Description) Test/Exam Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"components": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"components": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Test

Delete a test from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Test Components

Profile Test Component is a list of test components such as speaking, listening for the IELTS.

Each entry may contain the following fields:

Type
Score
Test at
Description

Get Test Components

Returns a list of components of the test.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"test_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Test Component

Create a component to the test.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Test Component

type required	string (Test/Exam Component Type) Enum: "speaking" "writing" "reading" "listening" Test/Exam Component Type
score	integer (Test/Exam Component Score) Test/Exam Component Score
test_at	string <date> (Test/Exam Component At) Test/Exam Component Date
description	string (Description) Test/Exam Component Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"test_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Test Component

Retrieve a single test component details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id
component_id required	string <uuid> (Test/Exam Component Id) Test Component Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"test_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Test Component

You can update fields of a component after the component is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id
component_id required	string <uuid> (Test/Exam Component Id) Test Component Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Test Component

type	string (Test/Exam Component Type) Enum: "speaking" "writing" "reading" "listening" Test/Exam Component Type
score	integer (Test/Exam Component Score) Test/Exam Component Score
test_at	string <date> (Test/Exam Component At) Test/Exam Component Date
description	string (Description) Test/Exam Component Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"test_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Test Component

Updates one or more fields in a component. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id
component_id required	string <uuid> (Test/Exam Component Id) Test Component Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Test Component

type	string (Test/Exam Component Type) Enum: "speaking" "writing" "reading" "listening" Test/Exam Component Type
score	integer (Test/Exam Component Score) Test/Exam Component Score
test_at	string <date> (Test/Exam Component At) Test/Exam Component Date
description	string (Description) Test/Exam Component Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded",
"test_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "ielts",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "speaking",
"score": 7,
"test_at": "2019-08-24",
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Test Component

Delete a component from the test.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
test_id required	string <uuid> (Test/Exam Id) Test Id
component_id required	string <uuid> (Test/Exam Component Id) Test Component Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Awards

Profile Award is a list of award or honor data.

Each entry may contain the following fields:

Type
Name
Number
Description
Issued at
Expiry at

Get Awards

Returns a list of awards of the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Award

Create an award to the profile.

Authorizations:

Scopes

path Parameters

profile_id

required

string <uuid> (Profile Id)

Profile Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Award

type required	string (Award Type) Enum: "award" "honor" "praise" Award Type
name required	string (Name) Award Name
number	string (Number) Award Number
description	string (Description) Award Description
issued_at	string <date> (Issued At) Award Issued Date
expiry_at	string <date> (Expiry At) Award Expiry Date
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Award

Retrieve a single award details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
award_id required	string <uuid> (Award Id) Award Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Award

You can update fields of an award after the award is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
award_id required	string <uuid> (Award Id) Award Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Award

type	string (Award Type) Enum: "award" "honor" "praise" Award Type
name	string (Name) Award Name
number	string (Number) Award Number
description	string (Description) Award Description
issued_at	string <date> (Issued At) Award Issued Date
expiry_at	string <date> (Expiry At) Award Expiry Date
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Award

Updates one or more fields in an award. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
award_id required	string <uuid> (Award Id) Award Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Award

type	string (Award Type) Enum: "award" "honor" "praise" Award Type
name	string (Name) Award Name
number	string (Number) Award Number
description	string (Description) Award Description
issued_at	string <date> (Issued At) Award Issued Date
expiry_at	string <date> (Expiry At) Award Expiry Date
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"type": "award",
"name": "Honor",
"number": "AWD10001",
"description": "Some description text here.",
"issued_at": "2019-08-24",
"expiry_at": "2019-08-24",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Award

Delete an award from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
award_id required	string <uuid> (Award Id) Award Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Contents

Profile Content is a list of contents defined in the content type of the profile type.

Get Contents

Returns a list of contents of the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Contents

Create contents to the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Content

	Array of objects (Content Attributes) Content Attributes
description	string (Description) Content Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Content

Retrieve a single content details.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
content_type_id required	string (Content Type Id) Example: location Content Type Id
content_id required	string <uuid> (Content Id) Content Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Content

You can update fields of a content after the content is created.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
content_id required	string <uuid> (Content Id) Content Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Content

	Array of objects (Content Attributes) Content Attributes
description	string (Description) Content Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Contents

Updates one or more fields in a content. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
content_id required	string <uuid> (Content Id) Content Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Content

	Array of objects (Content Attributes) Content Attributes
description	string (Description) Content Description
verified	boolean (Verified) Default: false Verified
verified_at	string <date-time> (Verified At) Default: null Verified Date and Time

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"profile_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "location_id",
"value": "123-abc-456-efg"
}
],
"description": "Some description text here.",
"verified": false,
"verified_at": null,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Content

Delete a content from the profile.

Authorizations:

Scopes

path Parameters

profile_id required	string <uuid> (Profile Id) Profile Id
content_id required	string <uuid> (Content Id) Content Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Types

The profile type defines the content types and attributes that define the structure of your profiles.

Get Types

Returns a list of types that the requesting user is permitted to view.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"attributes": 0,
"content_types": 0,
"profiles": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"content_types": [{"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"profiles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Type

Create a profile type.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Profile Type

id required	string (Type Id) Profile Type Id
name required	string (Type Name) Profile Type Name
description	string (Type Description) Profile Type Description
	object (Profile Type Metadata) Profile Type Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"attributes": 0,
"content_types": 0,
"profiles": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"content_types": [{"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"profiles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Type

Retrieve a single profile type details.

Authorizations:

Scopes

path Parameters

type_id

required

string (Type Id)

Example: candidate

Profile Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"attributes": 0,
"content_types": 0,
"profiles": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"content_types": [{"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"profiles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Type

You can update fields of a profile type after the profile type is created. The following fields can be updated any time after the profile type is created.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

type_id

required

string (Type Id)

Example: candidate

Profile Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Profile Type

id	string (Type Id) Profile Type Id
name	string (Type Name) Profile Type Name
description	string (Type Description) Profile Type Description
	object (Profile Type Metadata) Profile Type Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"attributes": 0,
"content_types": 0,
"profiles": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"content_types": [{"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"profiles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Type

Updates one or more fields in a profile type. The operation updates passed fields only.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

type_id

required

string (Type Id)

Example: candidate

Profile Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Profile Type

id	string (Type Id) Profile Type Id
name	string (Type Name) Profile Type Name
description	string (Type Description) Profile Type Description
	object (Profile Type Metadata) Profile Type Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"attributes": 0,
"content_types": 0,
"profiles": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"content_types": [{"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"profiles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type_id": "candidate",
"name": "John Doe",
"description": "A focussed, results-driven team player with many year experience in the field.",
"attributes": [{"id": "candidate_id",
"value": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"verified": false,
"verified_at": null,
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Type

Delete a profile type.

Authorizations:

Scopes

path Parameters

type_id

required

string (Type Id)

Example: candidate

Profile Type Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile Type Attributes

When you define a profile type, you specify attributes of the profile type that the user can select when creating a profile.

For example, suppose that you create a profile type and specify that it can be linked to candidate id and address. When users create a profile based on that profile type, they can only select candidate id and address for the new profile.

Every profile type consists of a required attribute at least for identifying a profile.

Get Attributes

Returns a list of attributes of the profile type that the requesting user is permitted to view.

Authorizations:

Scopes

path Parameters

type_id

required

string (Type Id)

Example: candidate

Profile Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create Attribute

Create an attribute to the profile type.

Authorizations:

Scopes

path Parameters

type_id

required

string (Type Id)

Example: candidate

Profile Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Attribute

id required	string (Attribute Id) Attribute Id
required required	boolean (Required) Default: false Attribute Required
name required	string (Attribute Name) Attribute Name
description	string (Attribute Description) Attribute Description

Responses

Request samples

Payload

Content type

application/json

{"id": "candidate_id",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID"
}

Response samples

Content type

application/json

{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Attribute

Retrieve a single attribute of profile type.

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
attribute_id required	string (Attribute Id) Example: candidate_id Attribute Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Attribute

You can update fields of an attribute of profile type after the attribute is created. The following fields can be updated any time after the attribute is created.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
attribute_id required	string (Attribute Id) Example: candidate_id Attribute Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Attribute

id	string (Attribute Id) Attribute Id
required	boolean (Required) Default: false Attribute Required
name	string (Attribute Name) Attribute Name
description	string (Attribute Description) Attribute Description

Responses

Request samples

Payload

Content type

application/json

{"id": "candidate_id",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID"
}

Response samples

Content type

application/json

{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Attribute

Updates one or more fields in an attribute of profile type. The operation updates passed fields only.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
attribute_id required	string (Attribute Id) Example: candidate_id Attribute Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Attribute

id	string (Attribute Id) Attribute Id
required	boolean (Required) Default: false Attribute Required
name	string (Attribute Name) Attribute Name
description	string (Attribute Description) Attribute Description

Responses

Request samples

Payload

Content type

application/json

{"id": "candidate_id",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID"
}

Response samples

Content type

application/json

{"id": "candidate_id",
"type_id": "candidate",
"required": false,
"name": "Candidate ID",
"description": "Candidate ID",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Attribute

Delete an attribute from the profile type.

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
attribute_id required	string (Attribute Id) Example: candidate_id Attribute Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Content Types

A content type is a broad definition of a group of items that can be added to the profile type. Within a content type, specify attributes for all items of this type can or must have.

Get Content Types

Returns a list of content types of the profile type that the requesting user is permitted to view.

Authorizations:

Scopes

path Parameters

type_id

required

string (Type Id)

Example: candidate

Profile Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "location",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type_id": "location",
"attributes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"content_type_id": "location",
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Content Type

Create a content type to the profile type.

Authorizations:

Scopes

path Parameters

type_id

required

string (Type Id)

Example: candidate

Profile Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Content Type

id	string (Content Type Id) Content Type Id
name required	string (Content Type Name) Content Type Name
description	string (Content Type Description) Content Type Description
	object (Content Type Metadata) Content Type Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "location",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "location",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type_id": "location",
"attributes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"content_type_id": "location",
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Content Type

Retrieve a single content type of the profile type.

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "location",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type_id": "location",
"attributes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"content_type_id": "location",
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Content Type

You can update fields of a content type of profile type after the content type is created. The following fields can be updated any time after the content type is created.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Content Type

id	string (Content Type Id) Content Type Id
name	string (Content Type Name) Content Type Name
description	string (Content Type Description) Content Type Description
	object (Content Type Metadata) Content Type Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "location",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "location",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type_id": "location",
"attributes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"content_type_id": "location",
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Content Type

Updates one or more fields in a content type of profile type. The operation updates passed fields only.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Content Type

id	string (Content Type Id) Content Type Id
name	string (Content Type Name) Content Type Name
description	string (Content Type Description) Content Type Description
	object (Content Type Metadata) Content Type Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "location",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "location",
"type_id": "candidate",
"type_data": {"id": "candidate",
"name": "Candidate Profile",
"description": "Candidate Profile for Hischool Recruit",
"metadata": {"builtin_content_types": ["name",
"image",
"email",
"phone",
"web",
"social",
"address",
"education",
"language",
"skill",
"experience",
"attachment",
"citizenship",
"award",
"test"
],
"options": {"name": {"multiple_occurrence": true,
"types": ["full_name",
"first_name",
"last_name"
]
},
"image": {"multiple_occurrence": true,
"types": ["profile",
"cover"
]
},
"email": {"multiple_occurrence": true,
"types": ["work",
"personal"
]
},
"phone": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"web": {"multiple_occurrence": true,
"types": ["work",
"home"
]
},
"social": {"multiple_occurrence": true,
"types": ["facebook",
"twitter",
"instagram"
]
},
"address": {"multiple_occurrence": true,
"types": ["work",
"hone"
]
},
"education": { },
"language": { },
"skill": { },
"experience": { },
"attachment": { }
},
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type_id": "location",
"attributes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"attributes": [{"content_type_id": "location",
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Content Type

Delete a content type from the profile type.

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Content Type Attributes

When you add a content type to a profile type, you add the attributes that define the information entered for that specific profile type.

Get Attributes

Returns a list of attributes of the content type that the requesting user is permitted to view.

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create Attribute

Create an attribute to the content type.

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Attribute

id required	string (Attribute Id) Attribute Id
type required	string (Attribute Type) Enum: "string" "number" "date" "lov" "rating" Attribute Types: String Number Date List of Values (LOV) Rating Scale
required required	boolean (Required) Default: false Attribute Required
name required	string (Attribute Name) Attribute Name
description	string (Attribute Description) Attribute Description
	String (object) or Number (object) or Date (object) or List of Values (LOV) (object) or Rating (object) (Attribute Metadata) Attribute Metadata. It depends on attribute type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Attribute

Retrieve a single attribute of content type.

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id
attribute_id required	string (Attribute Id) Example: location_id Attribute Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Attribute

You can update fields of an attribute of content type after the attribute is created. The following fields can be updated any time after the attribute is created.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id
attribute_id required	string (Attribute Id) Example: location_id Attribute Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Attribute

id	string (Attribute Id) Attribute Id
required	boolean (Required) Default: false Attribute Required
name	string (Attribute Name) Attribute Name
description	string (Attribute Description) Attribute Description
	String (object) or Number (object) or Date (object) or List of Values (LOV) (object) or Rating (object) (Attribute Metadata) Attribute Metadata. It depends on attribute type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "location_id",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Attribute

Updates one or more fields in an attribute of content type. The operation updates passed fields only.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id
attribute_id required	string (Attribute Id) Example: location_id Attribute Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Attribute

id	string (Attribute Id) Attribute Id
required	boolean (Required) Default: false Attribute Required
name	string (Attribute Name) Attribute Name
description	string (Attribute Description) Attribute Description
	String (object) or Number (object) or Date (object) or List of Values (LOV) (object) or Rating (object) (Attribute Metadata) Attribute Metadata. It depends on attribute type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "location_id",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"content_type_id": "location",
"content_type_data": {"id": "location",
"type_id": "candidate",
"name": "Location",
"description": "Location",
"metadata": {"multiple_occurrence": true,
"tags": ["aircampi",
"recruit",
"candidate"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"id": "location_id",
"type": "string",
"required": false,
"name": "Location ID",
"description": "Location ID",
"metadata": { },
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Attribute

Delete an attribute from the content type.

Authorizations:

Scopes

path Parameters

type_id required	string (Type Id) Example: candidate Profile Type Id
content_type_id required	string (Content Type Id) Example: location Content Type Id
attribute_id required	string (Attribute Id) Example: location_id Attribute Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Rating Scales

Rating scales define the values that can be used to rate an profile's performance or level of proficiency.

Get Scales

Returns a list of scales that the requesting user is permitted to view.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scale_id": "language_skill",
"levels": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Scale

Create a rating scale.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Rating Scale

id	string (Scale Id) Scale Id
name required	string (Name) Scale Description
description	string (Name) Scale Description
	object (Scale Metadata) Scale Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.
	Array of objects (Levels) Levels to create

Responses

Request samples

Payload

Content type

application/json

{"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"levels": [{"id": "proficiency",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1
}
]
}

Response samples

Content type

application/json

{"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scale_id": "language_skill",
"levels": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Get Scale

Retrieve a single rating scale details.

Authorizations:

Scopes

path Parameters

scale_id

required

string (Scale Id)

Example: language_skill

Scale Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scale_id": "language_skill",
"levels": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Update Scale

You can update fields of a rating scale after the rating scale is created. The following fields can be updated any time after the rating scale is created.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

scale_id

required

string (Scale Id)

Example: language_skill

Scale Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rating Scale

id	string (Scale Id) Scale Id
name	string (Name) Scale Description
description	string (Name) Scale Description
	object (Scale Metadata) Scale Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scale_id": "language_skill",
"levels": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Scale

Updates one or more fields in a rating scale. The operation updates passed fields only.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

scale_id

required

string (Scale Id)

Example: language_skill

Scale Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rating Scale

id	string (Scale Id) Scale Id
name	string (Name) Scale Description
description	string (Name) Scale Description
	object (Scale Metadata) Scale Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scale_id": "language_skill",
"levels": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"levels": [{"id": "proficiency",
"scale_id": "language_skill",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Rating Scale Levels

The rating scale defines the qualitative values, such as A, B, C, or D, that the system uses to rate or score an profile's performance. Each qualitative value can have a rating level, and numeric points in levels of the rating scale.

Get Levels

Returns a list of levels of the rating scale that the requesting user is permitted to view.

Authorizations:

Scopes

path Parameters

scale_id

required

string (Scale Id)

Example: language_skill

Scale Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "proficiency",
"scale_id": "language_skill",
"scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Create Level

Create a level to the rating scale.

Authorizations:

Scopes

path Parameters

scale_id

required

string (Scale Id)

Example: language_skill

Scale Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Rating Scale Level

id	string (Level Id) Level Id
name required	string (Name) Level Description
description	string (Name) Level Description
points	integer (Points) Level Points
sequence	integer (Sequence) Level Sequence

Responses

Request samples

Payload

Content type

application/json

{"id": "proficiency",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1
}

Response samples

Content type

application/json

{"id": "proficiency",
"scale_id": "language_skill",
"scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Get Level

Retrieve a single level of the rating scale.

Authorizations:

Scopes

path Parameters

scale_id required	string (Scale Id) Example: language_skill Scale Id
level_id required	string (Level Id) Example: proficiency Level Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "proficiency",
"scale_id": "language_skill",
"scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Update Level

You can update fields of a level of the rating scale after the level is created. The following fields can be updated any time after the level is created.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

scale_id required	string (Scale Id) Example: language_skill Scale Id
level_id required	string (Level Id) Example: proficiency Level Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rating Scale Level

id	string (Level Id) Level Id
name	string (Name) Level Description
description	string (Name) Level Description
points	integer (Points) Level Points
sequence	integer (Sequence) Level Sequence

Responses

Request samples

Payload

Content type

application/json

{"id": "proficiency",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1
}

Response samples

Content type

application/json

{"id": "proficiency",
"scale_id": "language_skill",
"scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Patch Level

Updates one or more fields in a level of the rating scale. The operation updates passed fields only.

Available fields to update:

id
name
description
metadata
app_metadata

Authorizations:

Scopes

path Parameters

scale_id required	string (Scale Id) Example: language_skill Scale Id
level_id required	string (Level Id) Example: proficiency Level Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Rating Scale Level

id	string (Level Id) Level Id
name	string (Name) Level Description
description	string (Name) Level Description
points	integer (Points) Level Points
sequence	integer (Sequence) Level Sequence

Responses

Request samples

Payload

Content type

application/json

{"id": "proficiency",
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1
}

Response samples

Content type

application/json

{"id": "proficiency",
"scale_id": "language_skill",
"scale_data": {"id": "language_skill",
"name": "Language Skill",
"description": "Language Skill",
"metadata": {"tags": ["adventurer",
"fisher"
]
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"name": "Proficiency",
"description": "Proficiency Level",
"points": 1,
"sequence": 1,
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Delete Level

Delete a level from the rating scale.

Authorizations:

Scopes

path Parameters

scale_id required	string (Scale Id) Example: language_skill Scale Id
level_id required	string (Level Id) Example: proficiency Level Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Profile APIs (v1)

Introduction

Data Model

Endpoints

General:

Profile Management:

Profile Types:

Rating Scales:

Server Health

Check Health

Responses

Response samples

Server Settings

Get Server Settings

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Update Server Settings

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Patch Server Settings

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Profiles

Get Profiles

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Create Profile

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Profile

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Update Profile

Authorizations:

path Parameters

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Patch Profile

Authorizations:

path Parameters

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Profile

Authorizations:

path Parameters

header Parameters

Responses