Objects List

Get the list of objects and filter them based on various criteria

GET https://apigateway.boost.rs/matchbox/objects

Query Parameters

NameTypeDescription

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: documents.skills - returns the related skills documents.meta_skills - returns the related meta-skills documents.super_skills - returns the related super-skills

sort_by

String

This parameter is used to sort the results, Default value is 'id'. Below the full list of possible values: id name provider external_id

sort

String

Sorting order, can be asc or desc.

offset

Integer

This parameter is used to retrieve paginated results. The default setting is 0. For a specific page, set offset to be: (#pageNumber - 1) * :limit

limit

Integer

Number of records to return. Default setting is 10 records. Can take values between 1 and 100.

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 external_id field. The values are the ones used in the batch request for each document.

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 pool_id.

Headers

NameTypeDescription

Authorization*

String

Authorisation token received from oAuth API. Bearer :token

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.

{
    "success": true,
    "message": "",
    "result": [
        {
            "id": 1,
            "name": "my jobtitle",
            "external_id": "2345-JGAD943",
            "provider": "Somewhere",
            "object_type": "jobtitle",
            "documents": [
                {
                    "id": 1,
                    "title": "My jobtitle",
                    "status": "active",
                    "external_id": null,
                    "provider": null,
                    "document_type": "jobtitle"
                }
            ]
        },
        {
            "id": 2,
            "name": "my course",
            "external_id": "XKL-345876",
            "provider": "Extreme Training",
            "object_type": "course",
            "documents": [
                {
                    "id": 20,
                    "title": "User interface developer",
                    "status": "active",
                    "external_id": null,
                    "provider": null,
                    "document_type": "jobtitle"
                }
            ]
        },
        {
            "id": 3,
            "name": "Outdoor jobs",
            "external_id": null,
            "provider": "mihai s",
            "object_type": "jobtitle",
            "documents": [
                {
                    "id": 21,
                    "title": "Assistant outdoor animator",
                    "status": "active",
                    "external_id": null,
                    "provider": "Boostrs",
                    "document_type": "jobtitle"
                }
            ]
        },
        {
            "id": 6,
            "name": "my jobs in english",
            "external_id": "XKL-345876 en",
            "provider": "Locale EN",
            "object_type": "jobtitle",
            "documents": [
                {
                    "id": 782,
                    "title": "Data scientist",
                    "status": "active",
                    "external_id": null,
                    "provider": null,
                    "document_type": "jobtitle"
                },
                {
                    "id": 785,
                    "title": "managining director",
                    "status": "active",
                    "external_id": null,
                    "provider": null,
                    "document_type": "standardization"
                }
            ]
        },
        {
            "id": 7,
            "name": "my course",
            "external_id": "XKL-345876",
            "provider": "Extreme Training",
            "object_type": "course",
            "documents": []
        },
        {
            "id": 8,
            "name": "my course",
            "external_id": "XKL-345876",
            "provider": "Extreme Training",
            "object_type": "course",
            "documents": []
        },
        {
            "id": 9,
            "name": "User profile",
            "external_id": null,
            "provider": "Active directory",
            "object_type": "profile",
            "documents": []
        },
        {
            "id": 10,
            "name": "my posting",
            "external_id": "436554653243",
            "provider": null,
            "object_type": "job-posting",
            "documents": []
        }
    ]
}

Last updated