The Party Type object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

party_type string required
account_type string required
The Party Type object 
{
  "id": "party-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "party_type": "party_type_example",
  "account_type": "account_type_example"
}
GET /api/setup/party-type/{id}

Retrieve a party type

Retrieves the details of an existing party type. Supply the unique party type ID that was returned from a previous request.

Path parameters

id string required

The identifier of the party type to retrieve.

Returns

Returns the party type object if a valid identifier was provided.

GET /api/setup/party-type/{id} 
curl https://api.overplane.dev/api/setup/party-type/party-type_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "party-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "party_type": "party_type_example",
  "account_type": "account_type_example"
}
GET /api/setup/party-type

List all party types

Returns a list of party types. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of party type objects.

GET /api/setup/party-type 
curl https://api.overplane.dev/api/setup/party-type \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "party-type_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "party_type": "party_type_example",
      "account_type": "account_type_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/party-type

Create a party type

Creates a new party type object.

Body parameters

party_type string required
account_type string required

Returns

Returns the newly created party type object if the call succeeded.

POST /api/setup/party-type 
curl https://api.overplane.dev/api/setup/party-type \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"party_type":"party_type_example","account_type":"account_type_example"}'
Response 
{
  "id": "party-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "party_type": "party_type_example",
  "account_type": "account_type_example"
}
PATCH /api/setup/party-type/{id}

Update a party type

Updates the specified party type by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the party type to update.

Body parameters

party_type string
account_type string

Returns

Returns the updated party type object.

PATCH /api/setup/party-type/{id} 
curl https://api.overplane.dev/api/setup/party-type/party-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"party_type":"party_type_example","account_type":"account_type_example"}'
Response 
{
  "id": "party-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "party_type": "party_type_example",
  "account_type": "account_type_example"
}
DELETE /api/setup/party-type/{id}

Delete a party type

Permanently deletes a party type. This cannot be undone.

Path parameters

id string required

The identifier of the party type to delete.

Returns

Returns a confirmation that the party type has been deleted.

DELETE /api/setup/party-type/{id} 
curl https://api.overplane.dev/api/setup/party-type/party-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "party-type_abc123",
  "deleted": true
}