Skip to main content
GET
Get seasons

Headers

X-Delogue-Api
string

Query Parameters

Free-text search that matches seasons by name, project, or custom ID.

Ids
integer<int64>[]

Restricts results to seasons with any of these identifiers.

Names
string[]

Restricts results to seasons whose name matches any of these values.

Project
string

Restricts results to seasons whose project matches this value.

CustomId
string

Restricts results to seasons with this customer-defined identifier.

State
enum<string>

Filters seasons by lifecycle state. The lifecycle state of the season. A deactivated season stays on existing styles but is not offered when creating new ones.

Available options:
active,
inactive,
deleted
Properties
string[]

Presence filter that narrows the results. Include isLocked to return only locked seasons, and isAccessible to return only accessible seasons.

sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, ProjectName, CustomID, State, Position.

pageSize

The number of results per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

An opaque keyset pagination token. Mutually exclusive with filter, sort, pageSize, and pageNumber.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.