List Profiles

get

https://apiv2.{domain}.ai/api/v2/core/profiles

Search profiles using query parameters and get the complete profile objects

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

Specifies the offset value to start for the page

limit

integer

Specifies the number of entries to be returned for the page

atsCandidateId

string

Unique identifier in the ATS system

profileIds

string

Comma separated list of encoded profile ids

filterQuery

string

Filter query using predefined filter arguments documented here

query

string

Any wildcard text to search in position

include

string

Include additional fields in the response. Possible values are resume, applications, tags, notes, attachmentsInfo, inferredSkills, careerSiteQuestions, deletedAt, demandExperiences, jtnSubmissions

exclude

string

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyList

string

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorization

string

required

The secret key to access the api. It starts with the bearer token

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK