Appearance
Entities
This page documents on how to:
Fetch Entities
Fetch a list of entities
Scope
managers_read
Endpoint
GET /entities
The payload in this endpoint is paginated. Information will be provided in the headers.
Consult the guide for paginationAccepted params
All parameters should be in the querystring.
| Param | Type | Example value | Default | Description |
|---|---|---|---|---|
keywords | String | "Foo Bar" | null | Search from keywords in name, and reference fields |
order | String | "created_at" | "created_at" | Chosen field for ordering the data. Available values: ["created_at"] |
sort | String | "desc" | "desc" | Way of sorting the data. Available values: ["asc","desc"] |
page | Integer | 1 | 1 | Page to fetch |
per_page | Integer | 50 | 50 | Quantity of data by page (max value is 50) |
Examples
See all the entities that have "leeds" in their reference.
GET https://api.talentview.fr/v2/entities?keywords=leeds
Fetch Entity
Fetch one specific Entity from its id.
Scope
managers_read
Endpoint
GET /entities/:id
Accepted params
| Param | Type | Example Value | Default | Description |
|---|---|---|---|---|
id | Integer | 1 | - | In the path, id of the Entity to fetch. |
Examples
Retrieve an entity whose id is 88.
GET https://api.talentview.fr/v2/entities/88
Fetch Units
Fetch a list of units
Scope
managers_read
Endpoint
GET /entities/:entity_id/units
The payload in this endpoint is paginated. Information will be provided in the headers.
Consult the guide for paginationAccepted params (in the path)
| Param | Type | Example Value | Default | Description |
|---|---|---|---|---|
entity_id | Integer | 1 | - | id of the Entity's units to fetch. |
Accepted params (in the querystring)
| Param | Type | Example Value | Default | Description |
|---|---|---|---|---|
keywords | String | "Foo Bar" | null | Search from keywords in name, and reference fields |
order | String | "created_at" | "created_at" | Chosen field for ordering the data. Available values: ["created_at"] |
sort | String | "desc" | "desc" | Way of sorting the data. Available values: ["asc","desc"] |
page | Integer | 1 | 1 | Page to fetch |
per_page | Integer | 50 | 50 | Quantity of data by page (max value is 50) |
Examples
Retrieve every unit from entity whose id is 130.
GET https://api.talentview.fr/v2/entities/130/units
Fetch Unit
Fetch one specific Unit from its id and its Entity id.
Scope
managers_read
Endpoint
GET /entities/:entity_id/units/:id
Accepted params
All parameters should be in the path.
| Param | Type | Example Value | Default | Description |
|---|---|---|---|---|
entity_id | Integer | 1 | - | id of the related Entity. |
id | Integer | 1 | - | id of the Unit to fetch. |
Examples
Retrieve the unit with id 4708 from entity whose id is 130.
GET https://api.talentview.fr/v2/entities/130/units/4708