API docs by Redocly

Business API (1.0.0)

Download OpenAPI specification:Download


See here for general Business API documentation.

Group Member

Add a group member

header Parameters
X-Api-Key
required
string
Example: Hpm42xgy.LXu3C15JmnLhyiuwder6vX9DSyEiZ38Y
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Request Body schema: application/json
required
externalId
required
string

Unique within the group, any format

name
required
string
surname
required
string
email
required
string
phone
string or null

Country code excluded phone number, format XXX-XXX-XXXX

required
object

Responses

Request samples

Content type
application/json
{
  • "externalId": "2719",
  • "name": "Tim",
  • "surname": "Schmidt",
  • "email": "[email protected]",
  • "phone": "555-555-5555",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Find a group member

header Parameters
X-Api-Key
required
string
Example: Hpm42xgy.LXu3C15JmnLhyiuwder6vX9DSyEiZ38Y
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a group member

header Parameters
X-Api-Key
required
string
Example: Hpm42xgy.LXu3C15JmnLhyiuwder6vX9DSyEiZ38Y
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Request Body schema: application/json
required
externalId
string

Unique within the group, any format

name
string
surname
string
email
string
phone
string or null

Country code excluded phone number, format XXX-XXX-XXXX

object

Responses

Request samples

Content type
application/json
{
  • "externalId": "2719",
  • "name": "Tim",
  • "surname": "Schmidt",
  • "email": "[email protected]",
  • "phone": "555-555-5555",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Remove a group member

header Parameters
X-Api-Key
required
string
Example: Hpm42xgy.LXu3C15JmnLhyiuwder6vX9DSyEiZ38Y
Accept
required
string
Example: application\json

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Event

Find all events

Retrieve all events, optionally filtering by attributes.

query Parameters
filter[address.state][_eq]
string
Example: filter[address.state][_eq]=WI

Filters to apply for querying events. Use dot notation to access nested attributes like address.state. Supported operators include _eq, _neq, _gt, _gte, _lt, _lte.

header Parameters
X-Api-Key
required
string
Example: Hpm42xgy.LXu3C15JmnLhyiuwder6vX9DSyEiZ38Y
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "meta": {
    }
}