Affiliates

Get affiliates

Returns a list of affiliates that match the specified filters.

get/api/v1/partnership/member

Request

  • Base URL: https://cdn.app.axl.tech (the document declares no server; this is the origin it was published from)
  • URL: https://cdn.app.axl.tech/api/v1/partnership/member
  • Auth: API key in header Authorization

Query parameters

statisticFromDatestring date-time

Start of the statistics period

statisticToDatestring date-time

End of the statistics period

idstring

ID

excludeIdstring

Excluded ID

studentIdstring

Contact ID

codestring

Code

isActiveboolean

Active

createdFromDatestring date-time

Start of the creation date range

createdToDatestring date-time

End of the creation date range

acceptedFromDatestring date-time

Start of the acceptance date range

acceptedToDatestring date-time

End of the acceptance date range

studentIdsstring[]

Contact IDs

timezoneOffsetMininteger

Time zone offset in minutes

skipEmptyListboolean

Ignore empty lists

itemsTotalinteger

Total items

takeinteger

Number of results per page

skipinteger

Number of records to skip

searchstring

Search phrase

sortNamestring

Property to sort by

sortType'asc' | 'desc'

Sort order

useSortboolean

Apply sorting

useBaseFilterboolean

Use base filter

useItemsTotalboolean

Count total records

softDeletedboolean

Soft-deleted

idsstring[]

List of unique identifiers

Response

OK

successboolean

True if the error list is empty or missing, false otherwise.

resetTokenboolean

Tells the client that the authentication token must be reset.

Changes

No recorded changes to this operation across all 1 revision of this API.