Campaigns

This page documents on how to:

• Fetch a list of campaigns
• Fetch one campaign

Fetch campaigns

Fetch a list of campaigns broadcasted on your Jobboard.

Scope

campaigns_read

Endpoint

GET /jobboards/campaigns

Open in Postman

The payload in this endpoint is paginated. Information will be provided in the headers.

Consult the guide for pagination

Accepted params

All parameters should be in the querystring.

Param	Type	Example Value	Default	Description
company_id	Integer	1	null	Only returns campaigns from this Company (can be replaced by company_slug)
company_slug	String	my-awesome-company	null	Only returns campaigns from this Company (can be replaced by company_id)
embed	String	address	null	Wanted embedded data, separated with comas. Available values: [address,entity,public_tags]
entity_id	Integer	1	null	Only returns campaigns from this Entity (formely designated as a Brand)
order	String	created_at	created_at	Chosen field for ordering the data. Available values: [created_at,last_activation_at,name]
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)

Params will be ignored if empty.

Embedded data

In this endpoint, embedded data can be requested:

• address: Job offer Address
• entity: A Campaign can optionally take its identity from an Entity (formely designated as a Brand)
• public_tags: Campaign categories

Examples

Find all campaigns from a company with id 44

GET https://api.talentview.fr/v2/jobboards/campaigns?company_id=44

View response example

Fetch campaign

Fetch a specific Campaign broadcasted on your Jobboard from its id.

Scope

campaigns_read

Endpoint

GET /jobboards/campaigns/:id

Open in Postman

Accepted params

Param	Type	Example Value	Default	Description
id	Integer	1	null	In the path, id of the Campaign to fetch
embed	String	address	null	In the querystring, wanted embedded data, separated with comas. Available values: [address,entity,public_tags]

Embedded data

In this endpoint, embedded data can be requested:

• address: Job offer Address
• entity: A Campaign can optionally take its identity from an Entity (formely designated as a Brand)
• public_tags: Campaign categories

Examples

Retrieve all the data avalaible for a campaign.

GET https://api.talentview.fr/v2/jobboards/campaigns/42?embed=address,entity,public_tags

View response example