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, description, difficulty, created_at, updated_at, slug, file, cursus_id.

The sort field. Sorted by created_at desc by default.

Example:

To sort on partnerships on the fields file on a descending order and cursus_id on a ascending order:

...&sort=-file,cursus_id

filter optional . Must be one of: id, name, description, difficulty, created_at, updated_at, slug, file, cursus_id, tier, difficulty.

Filtering on one or more fields

Example:

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

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

Filterable fields:
  • id (standard field)
  • name (standard field)
  • description (standard field)
  • difficulty : Filter on a project's tier. Can be one of: 0, 1, 2, 3, 4, 5
  • created_at (standard field)
  • updated_at (standard field)
  • slug (standard field)
  • file (standard field)
  • cursus_id (standard field)
  • tier : Filter on a project's tier. Can be one of: 0, 1, 2, 3, 4, 5
  • difficulty : Filter on a project's tier. Can be one of: 0, 1, 2, 3, 4, 5
range optional . Must be one of: id, name, description, difficulty, created_at, updated_at, slug, file, cursus_id, difficulty.

Select on a particular range

Example:

To range on partnerships with the difficulty field between min_value and max_value:

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

Rangeable fields:
  • id
  • name
  • description
  • difficulty
  • created_at
  • updated_at
  • slug
  • file
  • cursus_id
  • difficulty
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

comments powered by <span class='logo-disqus'>Disqus</span>
GET /v2/partnerships
200
[
  {
    "id": 1,
    "name": "Ernser LLC",
    "slug": "ernser-llc",
    "tier": 1,
    "url": "https://api.intra.42.fr/v2/partnerships/ernser-llc",
    "partnerships_users_url": "https://api.intra.42.fr/v2/partnerships/ernser-llc/partnerships_users"
  }
]
curl  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.intra.42.fr/v2/partnerships"

[
  {
    "id": 1,
    "name": "Ernser LLC",
    "slug": "ernser-llc",
    "tier": 1,
    "url": "https://api.intra.42.fr/v2/partnerships/ernser-llc",
    "partnerships_users_url": "https://api.intra.42.fr/v2/partnerships/ernser-llc/partnerships_users"
  }
]
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/partnerships")
response.status
# => 200
response.parsed
# => [{"id"=>1, "name"=>"Ernser LLC", "slug"=>"ernser-llc", "tier"=>1, "url"=>"https://api.intra.42.fr/v2/partnerships/ernser-llc", "partnerships_users_url"=>"https://api.intra.42.fr/v2/partnerships/ernser-llc/partnerships_users"}]