Skip to content
Aller au contenu
Charitips

API reference · Sites

List sites

GET/v1/sites

List all your sites.

Requires a Bearer access token.

Parameters

  • limit#numberin queryintegerminimum 1maximum 100

    The max number of items to return.

  • cursor#stringin queryUUID

    The id of the last item from the previous page. Used to fetch the next page.

  • subdomain#stringin query

    Subdomain of your site

  • domain#stringin query

    Custom domain of your site

  • accountId#stringin queryUUID

    Id of the account. Only useful for Platform customers to filter sites by child accounts.

Response

200 · Site[]

No field is described in the spec.

  • siteId#stringalways returned

  • subdomain#string

  • customDomain#string

  • accountId#stringalways returned

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

Errors

  • 400A field is missing, has the wrong type, or is not part of the request schema.

    Every request with a body or query is validated.

    {
      "statusCode": 400,
      "message": [
        "amount must not be less than 1",
        "property foo should not exist"
      ],
      "error": "Bad Request"
    }
  • 401Unauthorized

    Missing, expired or invalid access token.

    {
      "statusCode": 401,
      "message": "Unauthorized"
    }
  • 403Account closed
    {
      "message": "Account closed",
      "code": "ACCOUNT_CLOSED"
    }
GET /v1/sites
curl -X GET https://api.sandbox.charitips.com/v1/sites \  -H "Authorization: Bearer $CHARITIPS_TOKEN"
Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.