API Reference

Sites API

Retrieve and manage site information

Sites API

Get information about customer sites under your dealer account.

Get Sites Information

Retrieve a list of all sites associated with your dealer account.

Endpoint

GET /ext/v1/sites

Request Headers

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Request Example

curl -X GET "https://api.chektdev.com/ext/v1/sites" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response (200 OK)

{
  "data": {
    "sites": [
      {
        "site_id": "site_123abc",
        "account_reference_id": "ACCT-001",
        "account_number": "1234567",
        "name": "Main Office",
        "address": {
          "street": "123 Main St",
          "city": "San Francisco",
          "state": "CA",
          "zip": "94102",
          "country": "US"
        },
        "status": "active",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-20T14:45:00Z"
      },
      {
        "site_id": "site_456def",
        "account_reference_id": "ACCT-002",
        "account_number": "7654321",
        "name": "Warehouse Location",
        "address": {
          "street": "456 Industrial Blvd",
          "city": "Oakland",
          "state": "CA",
          "zip": "94607",
          "country": "US"
        },
        "status": "active",
        "created_at": "2024-02-01T09:00:00Z",
        "updated_at": "2024-02-01T09:00:00Z"
      }
    ],
    "total_count": 2
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z"
  }
}

Response Fields

FieldTypeDescription
site_idstringUnique CHeKT site identifier
account_reference_idstringYour custom reference ID
account_numberstringAccount number
namestringSite name
addressobjectSite address details
statusstringSite status: active, inactive, suspended
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number
per_pageinteger20Items per page (max: 100)
statusstring-Filter by status: active, inactive
searchstring-Search by site name or address

Example with Filters

curl -X GET "https://api.chektdev.com/ext/v1/sites?status=active&per_page=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

Site Identifiers

You can reference sites using three different identifier types:

1. Site ID (site_id)

CHeKT's internal identifier:

site_123abc

2. Account Reference ID (account_reference_id)

Your custom reference ID:

ACCT-001

3. Account Number (account_number)

Traditional account number:

1234567

All other API endpoints support these three identifier types through different URL patterns:

  • /ext/v1/sites/{site_id}/...
  • /ref/v1/sites/{account_reference_id}/...
  • /txid/v1/sites/{account_number}/...

Error Responses

401 Unauthorized

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 Forbidden

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient permissions to access sites"
  }
}

429 Rate Limit Exceeded

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please try again later.",
    "retry_after": 60
  }
}

Next Steps