Back to endpoints

Get programs for an organization

GET api/V3/{language}/org/{orgIdentifier}/programs

?showHidden={showHidden}

&showArchived={showArchived}

&page={page}

&perPage={perPage}

Returns a list of programs ordered by id, with the option to show hidden and archived programs

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

 Required
orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

Required
showHidden (boolean)

Option to return hidden items.

Default value is False

 Optional
showArchived (boolean)

Option to also show archived items.

Default value is False

 Optional
page (integer)

Result page number that appears first.

Default value is 1

 Optional
perPage (integer)

Number of results per page.

Default value is 200

 Optional

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Id (integer)

Resource id
Name (string)

Resource name
Start (date)

Inclusive start limit. Format is 9999-12-31
End (date)

Inclusive end limit. Format is 9999-12-31
Url (string)

Url of the resource
PictureUrl (string)

Url of the resource picture
IsArchived (boolean)

True if resource is archived
IsVisible (boolean)

True when program is visible on Amilia pages
IsPasswordProtected (boolean)

Response Formats

CODE SAMPLE JSON 
[
  {
    "Id": 0,
    "Name": "Summer 2019",
    "Start": "0001-01-01T00:00:00-05:00",
    "End": "9999-12-31T18:59:59.9999999-05:00",
    "Url": "www.acme.com/summer2019",
    "PictureUrl": "img/summer2019.jpg",
    "IsArchived": false,
    "IsVisible": false,
    "IsPasswordProtected": false
  },
  {
    "Id": 0,
    "Name": "Summer 2019",
    "Start": "0001-01-01T00:00:00-05:00",
    "End": "9999-12-31T18:59:59.9999999-05:00",
    "Url": "www.acme.com/summer2019",
    "PictureUrl": "img/summer2019.jpg",
    "IsArchived": false,
    "IsVisible": false,
    "IsPasswordProtected": false
  }
]