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,

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