PSpscrpt
consents

List consents

Changed on
get/consents

Request

  • Base URL
    https://api.pscrpt.com/v1
  • URL
    https://api.pscrpt.com/v1/consents
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.pscrpt.com/oauth/authorize
      Token URL: https://api.pscrpt.com/oauth/token scopes: consent:read

Query parameters

page[limit]integer
page[after]string
filter[profile_id]string
filter[profile_id][in]ProfileId[]
filter[channel]string
Example:sms
filter[channel][in]Channel[] 
[
  "sms"
]
filter[status]'subscribed' | 'unsubscribed' | 'never_subscribed' | 'pending' | 'expired'
filter[status][in]ConsentStatus[]
filter[updated_at][gt]string date-time
Example:2026-07-23T17:32:01.123456Z
filter[updated_at][gte]string date-time
Example:2026-07-23T17:32:01.123456Z
filter[updated_at][lt]string date-time
Example:2026-07-23T17:32:01.123456Z
filter[updated_at][lte]string date-time
Example:2026-07-23T17:32:01.123456Z
sortstring

Sort field; a leading - is descending and its absence is ascending. Allowed field: updated_at. Default: -updated_at.

expandstring[]

Headers

Postscript-Versionstring date
Example:2026-07-23

Overrides the key's pinned API revision for this request.

Response

One page of consents.

Example response

{
  "data": [
    {
      "channel": "sms",
      "consented_at": "2026-07-23T17:32:01.123456Z",
      "identifier": {
        "created_at": "2026-07-23T17:32:01.123456Z",
        "type": "email",
        "updated_at": "2026-07-23T17:32:01.123456Z",
        "verified_at": "2026-07-23T17:32:01.123456Z"
      },
      "method": "checkout",
      "updated_at": "2026-07-23T17:32:01.123456Z"
    }
  ]
}

Changes