RefRef LogoRefRef

Get all participants

Retrieve a list of all participants

GET
/participants

Authorization

api-key<token>

API key authentication

In: header

api-key<token>

API key authentication via query parameter

In: query

Query Parameters

programIdstring

Filter participants by program ID

Format: "uuid"
statusstring

Filter participants by status

Value in: "active" | "inactive" | "completed"
limitinteger

Maximum number of participants to return

Default: 20Minimum: 1Maximum: 100
offsetinteger

Number of participants to skip

Default: 0Minimum: 0
curl -X GET "https://api.refref.com/v1/participants?programId=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=active" \
  -H "api-key: <token>"

Successful operation

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "programId": "bc59f66b-913a-48ec-ae2b-7ee29d7bcfbb",
      "firstName": "string",
      "lastName": "string",
      "email": "user@example.com",
      "status": "active",
      "joinedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

Edit on GitHub

Previous

Get participant by ID GET

Next

Get program by ID GET