ClientCasa
API

Venues

The places your events happen — reusable, with their own contacts, spaces and timezone.

A venue is a place you shoot, cater, plan or perform at — a hotel ballroom, a barn, a rooftop. Venues are reusable: create one once and attach it to event day after event day instead of retyping the address and the banquet manager's phone number every time.

Key Fields

  • name — what you call the place.
  • address — street, city, state, zip, country, plus a display name for the building or room.
  • timezone — the venue's own IANA timezone (America/Chicago). Set it when the venue is in a different zone from your organization, so call times read correctly on that day's run of show.
  • contacts[] — the people at the venue: a banquet manager, a security lead, a facilities contact. Each carries name, role, email and phone.
  • spaces[] — the rooms inside it (Grand Ballroom, Terrace), each with optional notes. A timeline item can name the space it happens in.
  • statusactive or archived. Archiving keeps a venue's history intact while taking it out of the pickers.
  • tagIds[] — your own tags, for grouping venues however you work.

How Venues Relate to Event Days

An event day points at a venue rather than copying it, so correcting an address once corrects it everywhere it is about to be printed. The venue's spaces are what a timeline item names when it says where something happens, and the venue's timezone is what the day's schedule is read in.

Archiving a venue does not touch the event days that already used it — past days keep the place they happened at.

GET
/api/v1/venues
x-api-key<token>

In: header

Query Parameters

page?integer
Default1
Range1 <= value
pageSize?integer
Default25
Range1 <= value <= 100
status?string
Value in"active" | "archived"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.clientcasa.com/api/v1/venues"
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string",
      "website": "string",
      "address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string"
      },
      "timezone": "string",
      "contacts": [
        {
          "name": "string",
          "role": "string",
          "email": "string",
          "phone": "string"
        }
      ],
      "spaces": [
        {
          "name": "string",
          "notes": "string"
        }
      ],
      "notes": "string",
      "tagIds": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "status": "active",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "total": 0,
    "totalPages": 0,
    "hasMore": true
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
POST
/api/v1/venues
x-api-key<token>

In: header

Header Parameters

Idempotency-Key?string

Optional unique key that makes this request safely retryable. Replaying the same key returns the original response instead of creating a duplicate; reusing a key with a different request body returns 409.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://www.clientcasa.com/api/v1/venues" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "string",
  "website": "string",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string"
  },
  "timezone": "string",
  "contacts": [
    {
      "name": "string",
      "role": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "spaces": [
    {
      "name": "string",
      "notes": "string"
    }
  ],
  "notes": "string",
  "tagIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "status": "active",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
GET
/api/v1/venues/{id}
x-api-key<token>

In: header

Path Parameters

id*string

UUID v4

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.clientcasa.com/api/v1/venues/550e8400-e29b-41d4-a716-446655440000"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "string",
  "website": "string",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string"
  },
  "timezone": "string",
  "contacts": [
    {
      "name": "string",
      "role": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "spaces": [
    {
      "name": "string",
      "notes": "string"
    }
  ],
  "notes": "string",
  "tagIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "status": "active",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
PATCH
/api/v1/venues/{id}
x-api-key<token>

In: header

Path Parameters

id*string

UUID v4

Formatuuid

Header Parameters

Idempotency-Key?string

Optional unique key that makes this request safely retryable. Replaying the same key returns the original response instead of creating a duplicate; reusing a key with a different request body returns 409.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://www.clientcasa.com/api/v1/venues/550e8400-e29b-41d4-a716-446655440000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "string",
  "website": "string",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string"
  },
  "timezone": "string",
  "contacts": [
    {
      "name": "string",
      "role": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "spaces": [
    {
      "name": "string",
      "notes": "string"
    }
  ],
  "notes": "string",
  "tagIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "status": "active",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
DELETE
/api/v1/venues/{id}
x-api-key<token>

In: header

Path Parameters

id*string

UUID v4

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://www.clientcasa.com/api/v1/venues/550e8400-e29b-41d4-a716-446655440000"
Empty
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "code": "archived_record_read_only",
      "property1": null,
      "property2": null
    }
  }
}

On this page