ALalternativepayments
Tags

List tags

Changed on

List all tags owned by the partner, including system tags. Use the returned IDs to tag customers.

get/tags

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/tags
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: tags:read

Query parameters

namestring

Case-insensitive substring match on tag name

customer_idstring

Only return tags applied to this customer

limitinteger

Page size

afterstring

Return tags after this cursor (end_cursor of the previous page)

beforestring

Return tags before this cursor (start_cursor of the next page)

Response

OK

end_cursorstring
has_next_pageboolean
has_previous_pageboolean
start_cursorstring

Example response

{
  "data": [
    {
      "id": "0b8f3c5e-6d2a-4f1b-9a7e-3c4d5e6f7a8b",
      "partner_id": "5f2b7c1d-8e3a-4b6c-9d0e-1f2a3b4c5d6e"
    }
  ],
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}

Changes