List all gains

get

https://api.airsaas.io/v1/gains/

Returns a paginated list of all Gains of the workspace, accessible by the authorization token used.

Expandable Properties

This endpoint supports relations expansion on:

owner
data_owner
project
workspace_program
nature
unit

Read more in our section about expandable properties.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

data_owner

string

Filter gains by Data Owner. Use the ID of a workspace user.

expand

string

Which relations to expand. Available relations: owner, data_owner, project, workspace_program, nature, unit.

health

string

Filter gains by Health. Use the code of a gain health (e.g. good, issues, critical, blocked).

nature

string

Filter gains by Nature. Use a gain nature ID.

ordering

string

Which field to use when ordering the results. Available options: title, status, health, created_at, progress. Ascending order by default, use a - before the name of the field to have a descending order (ex: ordering=-title). Defaults to -created_at.

owner

string

Filter gains by Owner. Use the ID of a workspace user.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

parent_type

string

Filter gains by Parent Type: project or program.

program

string

Filter gains by Program. Use a program ID.

project

string

Filter gains by Project. Use a project ID.

status

string

Filter gains by Status. Use the code of a gain status.

unit

string

Filter gains by Unit. Use a gain unit ID.

value_type

string

Filter gains by Value Type: quantifiable or binary.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200