live_help Notes

chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
sort optional . Must be one of: id, name, created_at, updated_at, slug, kind, restricted, is_subscriptable.

The sort field. Sorted by id desc by default.

Example:

To sort on cursus on the fields restricted on a descending order and is_subscriptable on a ascending order:

...&sort=-restricted,is_subscriptable

filter optional . Must be one of: id, name, created_at, updated_at, slug, kind, restricted, is_subscriptable.

Filtering on one or more fields

Example:

To filter on cursus with the id field matching a_value or another_value:

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • name (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • slug (standard field)
  • kind (standard field)
  • restricted (standard field)
  • is_subscriptable (standard field)
range optional . Must be one of: id, name, created_at, updated_at, slug, kind, restricted, is_subscriptable.

Select on a particular range

Example:

To range on cursus with the is_subscriptable field between min_value and max_value:

...&range[is_subscriptable]=min_value,max_value

Rangeable fields:
  • id
  • name
  • created_at
  • updated_at
  • slug
  • kind
  • restricted
  • is_subscriptable
page optional . Must be a Hash

The pagination params, as a hash

page[number] optional . Must be Fixnum

The current page

page[size] optional . Must be Fixnum

The number of items per page, defaults to 30, maximum 100

GET /v2/cursus
200
[
  {
    "id": 2,
    "created_at": "2017-11-22T13:41:00.825Z",
    "name": "42",
    "slug": "42"
  },
  {
    "id": 1,
    "created_at": "2017-11-22T13:41:00.750Z",
    "name": "Piscine C",
    "slug": "piscine-c"
  }
]
curl  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.intra.42.fr/v2/cursus"

[
  {
    "id": 2,
    "created_at": "2017-11-22T13:41:00.825Z",
    "name": "42",
    "slug": "42"
  },
  {
    "id": 1,
    "created_at": "2017-11-22T13:41:00.750Z",
    "name": "Piscine C",
    "slug": "piscine-c"
  }
]
require "oauth2"
UID = "Your application uid"
SECRET = "Your application secret"
client = OAuth2::Client.new(UID, SECRET, site: "https://api.intra.42.fr")
token = client.client_credentials.get_token

response = token.get("/v2/cursus")
response.status
# => 200
response.parsed
# => [{"id"=>2, "created_at"=>"2017-11-22T13:41:00.825Z", "name"=>"42", "slug"=>"42"}, {"id"=>1, "created_at"=>"2017-11-22T13:41:00.750Z", "name"=>"Piscine C", "slug"=>"piscine-c"}]