Skip to main content
GET
/
api
/
public
/
programs
List programs
curl --request GET \
  --url https://api.wodup.dev/api/public/programs \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "access": "private",
    "id": "p_123abc",
    "name": "Strength and Conditioning",
    "period": "continuous",
    "status": "active"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
wodup-gym
string

Only used by platform integrations
ID of gym to execute on behalf of

Query Parameters

​
status
enum<string>
default:active

Filter by program status

Available options:
active,
archived,
all
​
limit
integer
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Required range: 1 <= x <= 100
​
after_cursor
string

A cursor for use in pagination. after_cursor is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after_cursor=obj_foo in order to fetch the next page of the list.

​
before_cursor
string

A cursor for use in pagination. before_cursor is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include before_cursor=obj_bar in order to fetch the previous page of the list.

Response

200 - application/json

Program list

​
id
integer
required

Program ID

​
name
string
required

Program name

​
status
enum<string>
required

Program status

Available options:
active,
archived
​
access
enum<string>

Program access

Available options:
all_members,
private
​
period
enum<string>

Program period

Available options:
continuous,
fixed,
template