v1

latestOpenAPI 3.0.12026-07-2466310316.3 KB

Positions

List Positions

get/api/v1/positions

Query parameters

includestring[]

Position relationships available for inclusion

Include related resources

fields[positions]PositionsReadableAttribute[]

Position readable attributes list

Include only specified fields of Position in response

fields[position_openings]PositionOpeningsReadableAttribute[]

Position Opening readable attributes list

Include only specified fields of Position Opening in response

fields[custom_attributes]CustomAttributesReadableAttribute[]

Custom Attribute readable attributes list

Include only specified fields of Custom Attribute in response

filter[parent_position_id]string

Parent position id filter

Filter records by Parent position id

filter[created_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at greater than this value

filter[created_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at less than this value

filter[updated_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at greater than this value

filter[updated_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at less than this value

sortstring[]

Position sortable attributes

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

page[number]integer

Example:1

The page number of records to return

page[size]integer

The number of records to return

stats[total]'count'

Example:count

Include the total number of matched records within the meta key of the response object.

Response

OK: Positions collection