List Entity Profile Applications

get

https://apiv2.{domain}.ai/api/v2/core/entity-profile-applications/{entityType}

Search entity profile applications using specific filter parameters and get all attributes of entity profile applications for a given entity id and entity type. JWT callers see only rows whose event they can read and whose candidate is visible to them on that event's Candidates tab; page by totalCount, since a page can be empty while more visible rows follow.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityType

string

enum

required

Entity type of the entity profile application (e.g. planned_event)

Allowed:

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

entityId

string

Filter on entity id associated with the application

include

string

Include additional fields in the response. Possible values are customInfo, currentStageInfo, stageHistory

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