Objects List
Get the list of objects and filter them based on various criteria
GET
https://apigateway.boost.rs/matchbox/objects
Query Parameters
Name | Type | Description |
---|---|---|
with[] | Array | The default response only returns the skills related to the content.
If the parameter is used, the response will return the items requested via the parameters. You may use multiple parameters.
Available array options:
|
sort_by | String | This parameter is used to sort the results, Default value is 'id'. Below the full list of possible values:
|
sort | String | Sorting order, can be |
offset | Integer | This parameter is used to retrieve paginated results.
The default setting is |
limit | Integer | Number of records to return. Default setting is |
provider | String | Filter objects by provider. The values are the ones used in the batch request for each document. |
external_id | String | Filter objects by the |
search_term | String | Filter the resulting list by items containing this value in their name. Min length: 3 characters. |
pool_id | Integer | Retrieve the objects linked (mapped) to a specific |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Authorisation token received from oAuth API.
|
Accept-Language | String | Allows you to specify if you want the output to be in one of the accepted languages. Format: ISO 639-1 language code. If no value is specified, the response language will be English. |
Last updated