Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

List your API keys

GET
/api/v1/settings/api-keys
curl --request GET \
  --url https://api.pitch2sale.com/api/v1/settings/api-keys \
  --header 'Authorization: Bearer <token>'

Lists the caller’s own personal access tokens; the token itself is never returned, only token_prefix.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The caller’s keys

Media typeapplication/json
object
keys
required
Array<object>
object
id
required
string
label
required
string
token_prefix
required
string
scopes
required
Array<string>
last_used_at
required
string | null
revoked_at
required
string | null
created_at
required
string
updated_at
required
string
Examplegenerated
{
  "keys": [
    {
      "id": "example",
      "label": "example",
      "token_prefix": "example",
      "scopes": [
        "example"
      ],
      "last_used_at": "example",
      "revoked_at": "example",
      "created_at": "example",
      "updated_at": "example"
    }
  ]
}

401

Section titled “401”

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “403”

Role permission or token scope missing

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}