{
"variable": [
{
"id": "baseUrl",
"key": "baseUrl",
"type": "string",
"name": "string",
"value": "https:\/\/app.crescat.io"
}
],
"info": {
"name": "Crescat",
"_postman_id": "60922619-9631-4f8d-8a5b-c6565e831e6f",
"description": "",
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json"
},
"item": [
{
"name": "Group",
"description": "",
"item": [
{
"name": "GET Group Event List",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/calendar",
"query": [
{
"key": "start",
"value": "tenetur",
"description": "Start of dates to query. If not provided: today. Format: 2000-01-01",
"disabled": false
},
{
"key": "end",
"value": "fugit",
"description": "End of dates to query. If not provided: today. Format: 2000-01-01",
"disabled": false
}
],
"raw": "{{baseUrl}}\/external\/v1\/calendar?start=tenetur&end=fugit"
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get array of all events for your group"
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n [\n {\n \"id\": 1,\n \"name\": \"Event Name\",\n \"start\": 2000-01-01 12:00:00,\n \"end\": 2000-01-01 15:00:00,\n \"event_type_id\": 1,\n \"fields\": [\n {\n \"id\": 1,\n \"show_time_id\": 1,\n \"value\": *,\n }\n for details on formatting: see event field format\n ],\n \"show_times\": [\n {\n \"id\": 1,\n \"title\": \"Show Title\",\n \"start\": 2000-01-01 12:00:00,\n \"end\": 2000-01-01 15:00:00,\n \"room_id\": 1,\n }\n ],\n \"rooms\": [\n {\n \"id\": 1,\n \"name\": \"Room Name\",\n \"title\": \"Show Title\",\n \"start\": 2000-01-01 12:00:00,\n \"end\": 2000-01-01 15:00:00,\n }\n ],\n }\n ]\n}",
"name": ""
}
]
},
{
"name": "GET Group Event Response Format",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/calendar\/format",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/calendar\/format"
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get format of events returned when requesting events"
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n event_types [\n {\n \"id\": 1,\n \"name\": \"Event Type\",\n }\n ],\n fields [\n {\n \"id\": 1,\n \"title\": \"Title of Your Field\",\n \"format\": String,\n }\n ]\n\nFormats of Fields:\n String\n Rich formatted Text\n Date (2000-01-01)\n Time (12:00:00)\n Document url\n Boolean\n}",
"name": ""
},
{
"header": [],
"code": 401,
"body": "",
"name": "Festival Not Found: either not existing, or not your festival."
}
]
}
]
},
{
"name": "Venue\/Rooms",
"description": "",
"item": [
{
"name": "GET Venue Rooms List",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/rooms",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/rooms"
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get array of all rooms on your venue"
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n [\n {\n \"id\": 1,\n \"name\": \"Room Name\",\n }\n ]\n}",
"name": ""
}
]
},
{
"name": "GET Room Booking List",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/rooms\/:roomId\/calendar",
"query": [
{
"key": "start",
"value": "assumenda",
"description": "Start of dates to query. If not provided: today. Format: 2000-01-01",
"disabled": false
},
{
"key": "end",
"value": "sit",
"description": "End of dates to query. If not provided: today. Format: 2000-01-01",
"disabled": false
}
],
"raw": "{{baseUrl}}\/external\/v1\/rooms\/:roomId\/calendar?start=assumenda&end=sit",
"variable": [
{
"id": "roomId",
"key": "roomId",
"value": "1",
"description": "The id of the room you want to get calendar for."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get array of all bookings for room"
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n [\n {\n \"id\": 1,\n \"name\": \"Event Name\",\n \"start\": 2000-01-01 12:00:00,\n \"end\": 2000-01-01 15:00:00,\n }\n ]\n}",
"name": ""
}
]
}
]
},
{
"name": "Festival",
"description": "\n APIs for managing public forms related to a specific festival.",
"item": [
{
"name": "GET Festival List",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/festivals",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/festivals"
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Array of all festivals for your organization."
},
"response": [
{
"header": [],
"code": 200,
"body": "{\nArray of all festivals for your organization.\n [\n {\n \"id\": 1,\n \"name\": \"Name of Your Festival\",\n \"start\": 2000-01-01 12:00:00,\n \"end\": 2000-01-01 15:00:00,\n }\n ]\n}",
"name": ""
}
]
},
{
"name": "GET Festival Performance List",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/festivals\/:festivalId\/performances",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/festivals\/:festivalId\/performances",
"variable": [
{
"id": "festivalId",
"key": "festivalId",
"value": "1",
"description": "The id of the festival you want to get performances for."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Which fields are set on the token itself \nWhich Contacts are included is set on the token itself, either\n * All Contacts\n * Travel Party\n * Primary"
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n [\n {\n \"id\": 1,\n \"name\": \"Performance Name\",\n \"type\": \"Performance Type\",\n \"fields\": [\n {\n \"id\": 1,\n \"value\": *,\n }\n for details on formatting: see performance field format\n ],\n \"events\": [\n {\n \"id\": 1,\n \"name\": \"Name of Event\",\n }\n ],\n \"contacts\": [\n {\n \"id\": 1,\n \"name\": \"Name of Contact\",\n \"first_name\": \"First Name of Contact\",\n \"last_name\": \"Last Name of Contact\",\n \"email\": \"Email of Contact\",\n \"phone\": \"Phone of Contact\",\n \"country_code\": \"Country Code of Contact\",\n \"primary\": \"Is the contact primary or not\",\n \"travel_party\": \"Is the contact part of travel party or not\",\n \"role\": \"Role of Contact\",\n \"type\": \"Type of Contact\",\n }\n ],\n }\n ]\n}",
"name": ""
}
]
},
{
"name": "GET Festival Performance Response Format & Definitions",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/festivals\/:festivalId\/performances\/format",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/festivals\/:festivalId\/performances\/format",
"variable": [
{
"id": "festivalId",
"key": "festivalId",
"value": "1",
"description": "The id of the festival you want to get performances for."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get format of all performance fields that will be included when requesting performances"
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n fields [\n {\n \"id\": 1,\n \"title\": \"Title of Your Field\",\n \"format\": String,\n }\n ]\n\nFormats of Fields:\n String\n Rich formatted Text\n Date (2000-01-01)\n Time (12:00:00)\n Document url\n Boolean\n}",
"name": ""
},
{
"header": [],
"code": 401,
"body": "",
"name": "Festival Not Found: either not existing, or not your festival."
}
]
},
{
"name": "GET Festival Event List",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/festivals\/:festivalId\/events",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/festivals\/:festivalId\/events",
"variable": [
{
"id": "festivalId",
"key": "festivalId",
"value": "1",
"description": "The id of the festival you want to get events for."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": ""
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n [\n {\n \"id\": 1,\n \"name\": \"Event Name\",\n \"start_date\": 2000-01-01,\n \"end_date\": 2000-01-01,\n \"production_period\": [\n \"start\": 2000-01-01 12:00:00,\n \"end\": 2000-01-01 15:00:00,\n ],\n \"fields\": [\n {\n \"id\": 1,\n \"show_time_id\": 1,\n \"value\": *,\n }\n for details on formatting: see event field format\n ],\n \"show_times\": [\n {\n \"id\": 1,\n \"title\": \"Show Title\",\n \"start\": 2000-01-01 12:00:00,\n \"end\": 2000-01-01 15:00:00,\n \"room_id\": 1,\n }\n ],\n \"festival_resources\": [\n {\n \"id\": 1,\n \"name\": \"Festival Resource\",\n }\n ],\n \"rooms\": [\n {\n \"id\": 1,\n \"title\": \"Show Title\",\n \"start\": 2000-01-01 12:00:00,\n \"end\": 2000-01-01 15:00:00,\n }\n ],\n \"performances\": [\n {\n \"id\": 1,\n \"name\": \"Performance Name\",\n }\n ],\n \"venue\": {\n \"id\": 1,\n \"name\": \"Venue Name\",\n \"address\": \"Venue Address\",\n \"city\": \"Venue City\",\n \"postal_code\": \"Postal Code\",\n \"country\": \"Country\",\n \"website\": \"Website\",\n \"phone\": \"Phone\",\n },\n }\n ]\n}",
"name": ""
}
]
},
{
"name": "GET Festival Event Response Format & Definitions",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/festivals\/:festivalId\/events\/format",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/festivals\/:festivalId\/events\/format",
"variable": [
{
"id": "festivalId",
"key": "festivalId",
"value": "1",
"description": "The id of the festival you want to get events for."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get format and info from fields that will be included when requesting events"
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n fields [\n {\n \"id\": 1,\n \"title\": \"Title of Your Field\",\n \"format\": String,\n }\n ],\n festival_event_types [\n {\n \"id\": 1,\n \"name\": \"Concert\",\n }\n ]\n\nFormats of Fields:\n String\n Rich formatted Text\n Date (2000-01-01)\n Time (12:00:00)\n Document url\n Boolean\n}",
"name": ""
},
{
"header": [],
"code": 401,
"body": "",
"name": "Festival Not Found: either not existing, or not your festival."
}
]
},
{
"name": "List Public Forms for Festival",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/festivals\/:festivalId\/public-forms",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/festivals\/:festivalId\/public-forms",
"variable": [
{
"id": "festivalId",
"key": "festivalId",
"value": "1",
"description": "The ID of the festival."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get an array of all public forms belonging to the specified festival that you own."
},
"response": [
{
"header": [],
"code": 200,
"body": "[\n{\n\"id\": 1,\n\"name\": \"Name of Your Public Form\"\n},\n{\n\"id\": 2,\n\"name\": \"Another Public Form\"\n}\n]",
"name": "Success"
},
{
"header": [],
"code": 401,
"body": "[]",
"name": "Unauthorized"
}
]
},
{
"name": "Get Public Form Responders",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/festivals\/:festivalId\/public-forms\/:publicFormId",
"query": [
{
"key": "public_form_field_ids[0]",
"value": "1",
"description": "optional An array of `PublicFormField` IDs. If provided, only these custom fields will be included in the `public_form_fields` array for each responder. If omitted or empty, no custom fields are included by default via this mechanism (resource might still include some).",
"disabled": false
},
{
"key": "public_form_field_ids[1]",
"value": "5",
"description": "optional An array of `PublicFormField` IDs. If provided, only these custom fields will be included in the `public_form_fields` array for each responder. If omitted or empty, no custom fields are included by default via this mechanism (resource might still include some).",
"disabled": false
},
{
"key": "public_form_field_ids[2]",
"value": "10",
"description": "optional An array of `PublicFormField` IDs. If provided, only these custom fields will be included in the `public_form_fields` array for each responder. If omitted or empty, no custom fields are included by default via this mechanism (resource might still include some).",
"disabled": false
}
],
"raw": "{{baseUrl}}\/external\/v1\/festivals\/:festivalId\/public-forms\/:publicFormId?public_form_field_ids[0]=1&public_form_field_ids[1]=5&public_form_field_ids[2]=10",
"variable": [
{
"id": "festivalId",
"key": "festivalId",
"value": "1",
"description": "The ID of the festival."
},
{
"id": "publicFormId",
"key": "publicFormId",
"value": "1",
"description": "The ID of the public form."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get an array of all responders (submissions) for a specific public form.\nYou can optionally filter which custom form fields are included in the response."
},
"response": [
{
"header": [],
"code": 200,
"body": "[\n{\n\"id\": 1,\n\"name\": \"John Doe\",\n\"first_name\": \"John\",\n\"last_name\": \"Doe\",\n\"email\": \"john.doe@example.com\",\n\"accepted_at\": \"2024-01-15 10:00:00\",\n\"declined_at\": null,\n\"public_form_fields\": [\n{\n\"id\": 1,\n\"value\": \"Value for custom field 1\"\n},\n{\n\"id\": 5,\n\"value\": true\n}\n\/\/ Other fields included based on public_form_field_ids query param\n\/\/ For details on value formatting: see 'Get Public Form Format' endpoint\n]\n}\n]",
"name": "Success"
},
{
"header": [],
"code": 401,
"body": "[]",
"name": "Unauthorized"
}
]
},
{
"name": "Get Public Form Format",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": "external\/v1\/festivals\/:festivalId\/public-forms\/:publicFormId\/format",
"query": [],
"raw": "{{baseUrl}}\/external\/v1\/festivals\/:festivalId\/public-forms\/:publicFormId\/format",
"variable": [
{
"id": "festivalId",
"key": "festivalId",
"value": "1",
"description": "The ID of the festival."
},
{
"id": "publicFormId",
"key": "publicFormId",
"value": "1",
"description": "The ID of the public form."
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
}
],
"body": null,
"description": "Get the definition and format of standard fields and custom fields for a specific public form's responses.\nUseful for understanding the data structure returned by the \"Get Public Form Responders\" endpoint."
},
"response": [
{
"header": [],
"code": 200,
"body": "{\n\"id\": \"Number\",\n\"name\": \"String\",\n\"first_name\": \"String\",\n\"last_name\": \"String | null\",\n\"phone\": \"String | null\",\n\"country_code\": \"String | null\",\n\"email\": \"String\",\n\"created_at\": \"String (YYYY-MM-DD HH:MM:SS)\",\n\"accepted_at\": \"String (YYYY-MM-DD HH:MM:SS) | null\",\n\"declined_at\": \"String (YYYY-MM-DD HH:MM:SS) | null\",\n\"assigned_work_minutes\": \"int\",\n\"expected_work_minutes\": \"int\",\n\"completed_work_minutes\": \"int\",\n\"public_form_fields\": [\n{\n\"id\": 1,\n\"title\": \"Title of Your Custom Field\",\n\"format\": \"String | Rich formatted Text | Date (YYYY-MM-DD) | Time (HH:MM:SS) | Document url | Boolean\",\n\"section\": \"Section Title | null\"\n}\n]\n}",
"name": "Success"
},
{
"header": [],
"code": 401,
"body": "[] Comment=\"Festival Not Found: either not existing, or not your festival, or the public form does not belong to this festival.\"",
"name": "Unauthorized"
}
]
}
]
}
],
"auth": {
"type": "bearer",
"bearer": [
{
"key": "key",
"type": "string"
}
]
}
}