Skip to content

lists

Lists of organizations you save: list, read with rows, create, add and remove rows, rename, archive, export as CSV.

Operations

List your Lists

Request

Your saved Lists of organizations, newest change first, without their rows. Use this when you need a List's id, or want to see which Lists exist before reading one. Newest change first, 25 to a page by default. Following is not listed here. total is null: this read does not count.

Security
bearerKey
Query
cursorstring, [ 1 .. 500 ] characters
limitinteger, [ 1 .. 100 ]
Default:25
purposestring
Enum:"general""targets""audience"
archivedboolean
curl -i -X GET \
  https://docs.societyhealth.co/_mock/docs/openapi/api/v1/lists \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Done.

Bodyapplication/json
okanyrequired
Value:true
dataobjectrequired
Response
{
  "ok": true,
  "data": {
    "items": [ … ],
    "nextCursor": null,
    "total": null
  }
}