Pre-release — content may change.

Overview

Complete REST API reference for the Wicket Member Data Platform

Overview

The Wicket Member Data Platform provides a RESTful API that follows the JSON:API specification. This reference documents all available endpoints, request parameters, and response formats.

New to the API? Start with our Getting Started guide to set up authentication and make your first request.

Working with the API

JSON:API Compliance

All API endpoints follow the JSON:API specification, which provides:

  • Consistent structure - Predictable request and response formats
  • Rich querying - Filtering, sorting, pagination, and sparse fieldsets
  • Resource relationships - Include related data in a single request
  • Error handling - Standardized error responses

Learn more about JSON:API concepts and how Wicket implements the specification.

Common Query Parameters

The API supports standard JSON:API query parameters across all endpoints:

ParameterDescriptionExample
includeInclude related resources?include=addresses,emails
filterFilter results by field values?filter[given_name]=John
page[number]Page number for pagination?page[number]=2
page[size]Number of results per page?page[size]=50
sortSort results by field?sort=-created_at
fieldsReturn only specific fields?fields[people]=given_name,family_name

See Filtering & Sorting and Pagination for detailed usage.

Authentication

All API requests require authentication using a Bearer token:

curl https://your-tenant.wicketcloud.com/api/v3/people \
  -H "Authorization: Bearer YOUR_API_SECRET"

Visit the Authentication guide to get your API credentials.

Rate Limits

The API enforces rate limits to ensure platform stability. See Rate Limits for current limits and best practices.

Response Format

All successful responses follow the JSON:API structure:

{
  "data": {
    "id": "uuid",
    "type": "people",
    "attributes": { /* resource fields */ },
    "relationships": { /* related resources */ }
  },
  "included": [ /* related resource objects */ ],
  "meta": { /* pagination, counts */ },
  "links": { /* pagination links */ }
}

Learn more about the Data Model and resource structure.

Need Help?

On this page