Skip to content
Aller au contenu
Charitips

API reference · Sites

Get a site

GET/v1/sites/{siteId}

Retrieve information about a site.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • siteId#stringin pathrequired

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

  • 401Unauthorized

    Missing, expired or invalid access token.

    {
  "statusCode": 401,
  "message": "Unauthorized"
}
  • 403Account closed
    {
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}
  • 404Not Found
    {
  "statusCode": 404,
  "message": "Not Found"
}
GET /v1/sites/<siteId>
curl -X GET https://api.sandbox.charitips.com/v1/sites/<siteId> \  -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.