{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:pinpoint/applications-list":{"get":{"operationId":"open_data_pinpoint_applications_list","summary":"List Applications","description":"GET /api/v1/applications","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"extra_fields[applications]","in":"query","required":false,"description":"Include fields that are not always needed, or perhaps computationally expensive","schema":{"type":"array","description":"Include fields that are not always needed, or perhaps computationally expensive"}},{"name":"fields[applications]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"filters[locale]","in":"query","required":false,"description":"Filter records that were submitted under that locale.","schema":{"type":"string","enum":["de","en","es","fr","pt","pt-BR"],"default":"en","description":"Filter records that were submitted under that locale."}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"filter[internal_candidate]","in":"query","required":false,"description":"Filter records based on whether they're marked as an internal candidate","schema":{"type":"boolean","description":"Filter records based on whether they're marked as an internal candidate"}},{"name":"filter[job_id]","in":"query","required":false,"description":"Filter records by their job ID","schema":{"type":"string","description":"Filter records by their job ID"}},{"name":"filter[job_visibility]","in":"query","required":false,"description":"Filter records by the visibility of the job that they belong to. To ensure backwards compatibility, applications belonging to confidential…","schema":{"type":"array","description":"Filter records by the visibility of the job that they belong to. To ensure backwards compatibility, applications belonging to confidential…"}},{"name":"filter[stage_basic_type]","in":"query","required":false,"description":"Filter records based on their stage basic type","schema":{"type":"array","description":"Filter records based on their stage basic type"}},{"name":"filter[stage_id]","in":"query","required":false,"description":"Filter records by their stage ID.","schema":{"type":"string","description":"Filter records by their stage ID."}},{"name":"filter[updated_at][gt]","in":"query","required":false,"description":"Filter records with a last update time greater than this value.","schema":{"type":"string","description":"Filter records with a last update time greater than this value."}},{"name":"filter[updated_at][lt]","in":"query","required":false,"description":"Filter records with a last update time less than this value.","schema":{"type":"string","description":"Filter records with a last update time less than this value."}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/applications-create-new-application":{"post":{"operationId":"open_data_pinpoint_applications_create_new_application","summary":"Create Application","description":"POST /api/v1/applications","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/applications-get-by-id":{"get":{"operationId":"open_data_pinpoint_applications_get_by_id","summary":"Fetch Application","description":"GET /api/v1/applications/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"fields[applications]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"extra_fields[applications]","in":"query","required":false,"description":"Include fields that are not always needed, or perhaps computationally expensive","schema":{"type":"array","description":"Include fields that are not always needed, or perhaps computationally expensive"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/applications-update-by-id":{"post":{"operationId":"open_data_pinpoint_applications_update_by_id","summary":"Update Application","description":"PUT /api/v1/applications/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/comments-list-get":{"get":{"operationId":"open_data_pinpoint_comments_list_get","summary":"List Comments","description":"GET /api/v1/comments","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[comments]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"filter[updated_at][gt]","in":"query","required":false,"description":"Filter records with a last update time greater than this value.","schema":{"type":"string","description":"Filter records with a last update time greater than this value."}},{"name":"filter[updated_at][lt]","in":"query","required":false,"description":"Filter records with a last update time less than this value.","schema":{"type":"string","description":"Filter records with a last update time less than this value."}},{"name":"filter[commentable_id]","in":"query","required":false,"description":"Filter records by their commentable ID","schema":{"type":"integer","description":"Filter records by their commentable ID"}},{"name":"filter[commentable_type]","in":"query","required":false,"description":"Filter records based on whether they are for applications or job seekers","schema":{"type":"array","description":"Filter records based on whether they are for applications or job seekers"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/comments-create-new":{"post":{"operationId":"open_data_pinpoint_comments_create_new","summary":"Create Comment","description":"POST /api/v1/comments","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/comments-get-by-id":{"get":{"operationId":"open_data_pinpoint_comments_get_by_id","summary":"Fetch Comment","description":"GET /api/v1/comments/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"fields[comments]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-attributes-list-attributes":{"get":{"operationId":"open_data_pinpoint_custom_attributes_list_attributes","summary":"List Custom Attributes","description":"GET /api/v1/custom_attributes","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[custom_attributes]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"filter[updated_at][gt]","in":"query","required":false,"description":"Filter records with a last update time greater than this value.","schema":{"type":"string","description":"Filter records with a last update time greater than this value."}},{"name":"filter[updated_at][lt]","in":"query","required":false,"description":"Filter records with a last update time less than this value.","schema":{"type":"string","description":"Filter records with a last update time less than this value."}},{"name":"filter[custom_attributable_id]","in":"query","required":false,"description":"Filter records by their custom_attributable ID","schema":{"type":"integer","description":"Filter records by their custom_attributable ID"}},{"name":"filter[custom_attributable_type]","in":"query","required":false,"description":"Filter records by the type of the associated resource","schema":{"type":"array","description":"Filter records by the type of the associated resource"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-attributes-create-new-attribute":{"post":{"operationId":"open_data_pinpoint_custom_attributes_create_new_attribute","summary":"Create Custom Attribute","description":"POST /api/v1/custom_attributes","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-attributes-get-attribute":{"get":{"operationId":"open_data_pinpoint_custom_attributes_get_attribute","summary":"Fetch Custom Attribute","description":"GET /api/v1/custom_attributes/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[custom_attributes]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-attributes-update-attribute-by-id":{"post":{"operationId":"open_data_pinpoint_custom_attributes_update_attribute_by_id","summary":"Update Custom Attribute","description":"PUT /api/v1/custom_attributes/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-attributes-remove-by-id":{"post":{"operationId":"open_data_pinpoint_custom_attributes_remove_by_id","summary":"Delete Custom Attribute","description":"DELETE /api/v1/custom_attributes/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-fields-list":{"get":{"operationId":"open_data_pinpoint_custom_fields_list","summary":"List Custom Fields","description":"GET /api/v1/custom_fields","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[custom_fields]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-fields-create-new-field":{"post":{"operationId":"open_data_pinpoint_custom_fields_create_new_field","summary":"Create Custom Field","description":"POST /api/v1/custom_fields","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-fields-get-field":{"get":{"operationId":"open_data_pinpoint_custom_fields_get_field","summary":"Fetch Custom Field","description":"GET /api/v1/custom_fields/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[custom_fields]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-fields-update-field-by-id":{"post":{"operationId":"open_data_pinpoint_custom_fields_update_field_by_id","summary":"Update Custom Field","description":"PUT /api/v1/custom_fields/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/custom-fields-delete-field":{"post":{"operationId":"open_data_pinpoint_custom_fields_delete_field","summary":"Delete Custom Field","description":"DELETE /api/v1/custom_fields/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/departments-list":{"get":{"operationId":"open_data_pinpoint_departments_list","summary":"List Departments","description":"GET /api/v1/departments","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[departments]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/departments-create-new-department":{"post":{"operationId":"open_data_pinpoint_departments_create_new_department","summary":"Create Department","description":"POST /api/v1/departments","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/departments-get-by-id":{"get":{"operationId":"open_data_pinpoint_departments_get_by_id","summary":"Fetch Department","description":"GET /api/v1/departments/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[departments]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/departments-update-by-id":{"post":{"operationId":"open_data_pinpoint_departments_update_by_id","summary":"Update Department","description":"PUT /api/v1/departments/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/departments-remove-by-id":{"post":{"operationId":"open_data_pinpoint_departments_remove_by_id","summary":"Delete Department","description":"DELETE /api/v1/departments/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/divisions-list":{"get":{"operationId":"open_data_pinpoint_divisions_list","summary":"List Divisions","description":"GET /api/v1/divisions","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[divisions]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/divisions-create-division":{"post":{"operationId":"open_data_pinpoint_divisions_create_division","summary":"Create Division","description":"POST /api/v1/divisions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/divisions-get-by-id":{"get":{"operationId":"open_data_pinpoint_divisions_get_by_id","summary":"Fetch Division","description":"GET /api/v1/divisions/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[divisions]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/divisions-update-by-id":{"post":{"operationId":"open_data_pinpoint_divisions_update_by_id","summary":"Update Division","description":"PUT /api/v1/divisions/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/divisions-remove-by-id":{"post":{"operationId":"open_data_pinpoint_divisions_remove_by_id","summary":"Delete Division","description":"DELETE /api/v1/divisions/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/equality-monitoring-categories-list":{"get":{"operationId":"open_data_pinpoint_equality_monitoring_categories_list","summary":"List equality monitoring categories","description":"GET /api/v1/equality_monitoring_categories","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"fields[equality_monitoring_categories]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"filter[enabled]","in":"query","required":false,"description":"Filter records based on whether they're marked as enabled","schema":{"type":"boolean","description":"Filter records based on whether they're marked as enabled"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}},{"name":"filter[updated_at][gt]","in":"query","required":false,"description":"Filter records with a last update time greater than this value.","schema":{"type":"string","description":"Filter records with a last update time greater than this value."}},{"name":"filter[updated_at][lt]","in":"query","required":false,"description":"Filter records with a last update time less than this value.","schema":{"type":"string","description":"Filter records with a last update time less than this value."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/equality-monitoring-categories-get-category-by-id":{"get":{"operationId":"open_data_pinpoint_equality_monitoring_categories_get_category_by_id","summary":"Fetch equality monitoring category","description":"GET /api/v1/equality_monitoring_categories/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"fields[equality_monitoring_categories]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/interviews-list-all":{"get":{"operationId":"open_data_pinpoint_interviews_list_all","summary":"List Interviews","description":"GET /api/v1/interviews","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[interviews]","in":"query","required":false,"description":"[Include only specified fields of Interview in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields of Interview in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"filter[interviewable_id]","in":"query","required":false,"description":"Filter records by interviewable ID","schema":{"type":"integer","description":"Filter records by interviewable ID"}},{"name":"filter[interviewable_type]","in":"query","required":false,"description":"Filter records based on whether they are for applications or job seekers","schema":{"type":"string","enum":["Application","JobSeeker"],"description":"Filter records based on whether they are for applications or job seekers"}},{"name":"filter[job_visibility]","in":"query","required":false,"description":"Filter records by the visibility of the job that they belong to. By default, interviews associated with applications for confidential jobs…","schema":{"type":"array","description":"Filter records by the visibility of the job that they belong to. By default, interviews associated with applications for confidential jobs…"}},{"name":"filter[start_at][gt]","in":"query","required":false,"description":"Filter records with a start at time greater than this value.","schema":{"type":"string","description":"Filter records with a start at time greater than this value."}},{"name":"filter[start_at][lt]","in":"query","required":false,"description":"Filter records with a start at time less than this value.","schema":{"type":"string","description":"Filter records with a start at time less than this value."}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/interviews-get-by-id":{"get":{"operationId":"open_data_pinpoint_interviews_get_by_id","summary":"Fetch Interview","description":"GET /api/v1/interviews/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[interviews]","in":"query","required":false,"description":"[Include only specified fields of Interview in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields of Interview in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/hiring-workflows-list-workflows":{"get":{"operationId":"open_data_pinpoint_hiring_workflows_list_workflows","summary":"List Hiring Workflows","description":"GET /api/v1/hiring_workflows","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/hiring-workflows-get-workflow-by-id":{"get":{"operationId":"open_data_pinpoint_hiring_workflows_get_workflow_by_id","summary":"Fetch Hiring Workflow","description":"GET /api/v1/hiring_workflows/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/jobs-list":{"get":{"operationId":"open_data_pinpoint_jobs_list","summary":"List Jobs","description":"GET /api/v1/jobs","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"filter[department_id]","in":"query","required":false,"description":"Filter by department ID","schema":{"type":"integer","description":"Filter by department ID"}},{"name":"filter[department_name]","in":"query","required":false,"description":"Filter by department name","schema":{"type":"string","description":"Filter by department name"}},{"name":"filter[division_id]","in":"query","required":false,"description":"Filter by division ID","schema":{"type":"integer","description":"Filter by division ID"}},{"name":"filter[division_name]","in":"query","required":false,"description":"Filter by division name","schema":{"type":"string","description":"Filter by division name"}},{"name":"filter[employment_type]","in":"query","required":false,"description":"Filter by employment type","schema":{"type":"array","description":"Filter by employment type"}},{"name":"filter[hiring_manager_user_id]","in":"query","required":false,"description":"Filter by hiring manager user ID","schema":{"type":"integer","description":"Filter by hiring manager user ID"}},{"name":"filter[location_id]","in":"query","required":false,"description":"Filter by location ID","schema":{"type":"integer","description":"Filter by location ID"}},{"name":"filter[location_name]","in":"query","required":false,"description":"Filter by location name","schema":{"type":"string","description":"Filter by location name"}},{"name":"filter[recruitment_manager_user_id]","in":"query","required":false,"description":"Filter by recruitment manager user ID","schema":{"type":"integer","description":"Filter by recruitment manager user ID"}},{"name":"filter[remote]","in":"query","required":false,"description":"Filter by whether the role is remote","schema":{"type":"boolean","description":"Filter by whether the role is remote"}},{"name":"filter[search]","in":"query","required":false,"description":"Perform a keyword search on the job title","schema":{"type":"string","description":"Perform a keyword search on the job title"}},{"name":"filter[status]","in":"query","required":false,"description":"Filter by status","schema":{"type":"array","description":"Filter by status"}},{"name":"filter[structure_custom_group_one_id]","in":"query","required":false,"description":"Filter by custom structure group ID","schema":{"type":"integer","description":"Filter by custom structure group ID"}},{"name":"filter[structure_custom_group_one_name]","in":"query","required":false,"description":"Filter by custom structure group name","schema":{"type":"string","description":"Filter by custom structure group name"}},{"name":"filter[visibility]","in":"query","required":false,"description":"Filter by whether this job is confidential, internal, external. To ensure backwards compatibility, confidential jobs are excluded from…","schema":{"type":"array","description":"Filter by whether this job is confidential, internal, external. To ensure backwards compatibility, confidential jobs are excluded from…"}},{"name":"filter[workplace_type]","in":"query","required":false,"description":"Filter by workplace type","schema":{"type":"array","description":"Filter by workplace type"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"locale","in":"query","required":false,"description":"Return translatable fields in the locale specified. `null` will be returned for a field if a translation has not been provided.","schema":{"type":"string","enum":["de","en","es","fr","pt","pt-BR"],"default":"en","description":"Return translatable fields in the locale specified. `null` will be returned for a field if a translation has not been provided."}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/jobs-create-job":{"post":{"operationId":"open_data_pinpoint_jobs_create_job","summary":"Create Job","description":"POST /api/v1/jobs","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/jobs-get-job-by-id":{"get":{"operationId":"open_data_pinpoint_jobs_get_job_by_id","summary":"Fetch Job","description":"GET /api/v1/jobs/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"locale","in":"query","required":false,"description":"Return translatable fields in the locale specified. `null` will be returned for a field if a translation has not been provided.","schema":{"type":"string","enum":["de","en","es","fr","pt","pt-BR"],"default":"en","description":"Return translatable fields in the locale specified. `null` will be returned for a field if a translation has not been provided."}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"fields[jobs]","in":"query","required":false,"description":"[Include only specified fields of Job in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields of Job in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/jobs-update-job-by-id":{"post":{"operationId":"open_data_pinpoint_jobs_update_job_by_id","summary":"Update Job","description":"PUT /api/v1/jobs/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/jobs-delete-job":{"post":{"operationId":"open_data_pinpoint_jobs_delete_job","summary":"Delete Job","description":"DELETE /api/v1/jobs/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/job-seekers-list-job-seekers":{"get":{"operationId":"open_data_pinpoint_job_seekers_list_job_seekers","summary":"List Job Seekers","description":"GET /api/v1/job_seekers","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"extra_fields[job_seekers]","in":"query","required":false,"description":"Include fields that are not always needed, and perhaps computationally expensive","schema":{"type":"array","description":"Include fields that are not always needed, and perhaps computationally expensive"}},{"name":"fields[job_seekers]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/job-seekers-get-job-seeker-by-id":{"get":{"operationId":"open_data_pinpoint_job_seekers_get_job_seeker_by_id","summary":"Fetch Job Seeker","description":"GET /api/v1/job_seekers/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"extra_fields[job_seekers]","in":"query","required":false,"description":"Include fields that are not always needed, and perhaps computationally expensive","schema":{"type":"array","description":"Include fields that are not always needed, and perhaps computationally expensive"}},{"name":"fields[job_seekers]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/locations-list":{"get":{"operationId":"open_data_pinpoint_locations_list","summary":"List Locations","description":"GET /api/v1/locations","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[locations]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/locations-create-location":{"post":{"operationId":"open_data_pinpoint_locations_create_location","summary":"Create Location","description":"POST /api/v1/locations","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/locations-get-location":{"get":{"operationId":"open_data_pinpoint_locations_get_location","summary":"Fetch Location","description":"GET /api/v1/locations/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[locations]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/locations-update-location-by-id":{"post":{"operationId":"open_data_pinpoint_locations_update_location_by_id","summary":"Update Location","description":"PUT /api/v1/locations/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/locations-remove-location":{"post":{"operationId":"open_data_pinpoint_locations_remove_location","summary":"Delete Location","description":"DELETE /api/v1/locations/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/onboarding-applications-list-applications":{"get":{"operationId":"open_data_pinpoint_onboarding_applications_list_applications","summary":"List Onboarding Applications","description":"GET /api/v1/onboarding_applications","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"fields[onboarding_applications]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"filter[start_at][gt]","in":"query","required":false,"description":"Filter records with a start at time greater than this value.","schema":{"type":"string","description":"Filter records with a start at time greater than this value."}},{"name":"filter[start_at][lt]","in":"query","required":false,"description":"Filter records with a start at time less than this value.","schema":{"type":"string","description":"Filter records with a start at time less than this value."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}},{"name":"filter[updated_at][gt]","in":"query","required":false,"description":"Filter records with a last update time greater than this value.","schema":{"type":"string","description":"Filter records with a last update time greater than this value."}},{"name":"filter[updated_at][lt]","in":"query","required":false,"description":"Filter records with a last update time less than this value.","schema":{"type":"string","description":"Filter records with a last update time less than this value."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/onboarding-applications-get-by-id":{"get":{"operationId":"open_data_pinpoint_onboarding_applications_get_by_id","summary":"Fetch Onboarding Application","description":"GET /api/v1/onboarding_applications/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[onboarding_applications]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/requisition-templates-list-templates":{"get":{"operationId":"open_data_pinpoint_requisition_templates_list_templates","summary":"List Requisition Templates","description":"GET /api/v1/requisition_templates","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[requisition_templates]","in":"query","required":false,"description":"[Include only specified fields of Requisition template in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields of Requisition template in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"filter[updated_at][gt]","in":"query","required":false,"description":"Filter records with a last update time greater than this value.","schema":{"type":"string","description":"Filter records with a last update time greater than this value."}},{"name":"filter[updated_at][lt]","in":"query","required":false,"description":"Filter records with a last update time less than this value.","schema":{"type":"string","description":"Filter records with a last update time less than this value."}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/requisition-templates-get-by-id":{"get":{"operationId":"open_data_pinpoint_requisition_templates_get_by_id","summary":"Fetch Requisition Template","description":"GET /api/v1/requisition_templates/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"fields[requisition_templates]","in":"query","required":false,"description":"[Include only specified fields of Requisition template in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields of Requisition template in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/requisitions-list-requisitions":{"get":{"operationId":"open_data_pinpoint_requisitions_list_requisitions","summary":"List Requisitions","description":"GET /api/v1/requisitions","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[requisitions]","in":"query","required":false,"description":"[Include only specified fields of Requisition in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields of Requisition in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter records with a creation time greater than this value.","schema":{"type":"string","description":"Filter records with a creation time greater than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter records with a creation time less than this value.","schema":{"type":"string","description":"Filter records with a creation time less than this value."}},{"name":"filter[updated_at][gt]","in":"query","required":false,"description":"Filter records with a last update time greater than this value.","schema":{"type":"string","description":"Filter records with a last update time greater than this value."}},{"name":"filter[updated_at][lt]","in":"query","required":false,"description":"Filter records with a last update time less than this value.","schema":{"type":"string","description":"Filter records with a last update time less than this value."}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/requisitions-create-new-requisition":{"post":{"operationId":"open_data_pinpoint_requisitions_create_new_requisition","summary":"Create Requisition","description":"POST /api/v1/requisitions","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/requisitions-get-by-id":{"get":{"operationId":"open_data_pinpoint_requisitions_get_by_id","summary":"Fetch Requisition","description":"GET /api/v1/requisitions/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"fields[requisitions]","in":"query","required":false,"description":"[Include only specified fields of Requisition in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields of Requisition in response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/requisitions-update-by-id":{"post":{"operationId":"open_data_pinpoint_requisitions_update_by_id","summary":"Update Requisition","description":"PUT /api/v1/requisitions/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/requisitions-remove-by-id":{"post":{"operationId":"open_data_pinpoint_requisitions_remove_by_id","summary":"Delete Requisition","description":"DELETE /api/v1/requisitions/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-custom-group-ones-list":{"get":{"operationId":"open_data_pinpoint_structure_custom_group_ones_list","summary":"List Structure Custom Group Ones","description":"GET /api/v1/structure_custom_group_ones","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[structure_custom_group_ones]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"sort","in":"query","required":false,"description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…","schema":{"type":"array","description":"[Sort records according to one or more criteria](https://jsonapi.org/format/#fetching-sorting) You should not include both ascending `id`…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-custom-group-ones-create-new-group":{"post":{"operationId":"open_data_pinpoint_structure_custom_group_ones_create_new_group","summary":"Create Structure Custom Group One","description":"POST /api/v1/structure_custom_group_ones","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-custom-group-ones-get-one":{"get":{"operationId":"open_data_pinpoint_structure_custom_group_ones_get_one","summary":"Fetch Structure Custom Group One","description":"GET /api/v1/structure_custom_group_ones/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[structure_custom_group_ones]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-custom-group-ones-update-one":{"post":{"operationId":"open_data_pinpoint_structure_custom_group_ones_update_one","summary":"Update Structure Custom Group One","description":"PUT /api/v1/structure_custom_group_ones/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-custom-group-ones-delete":{"post":{"operationId":"open_data_pinpoint_structure_custom_group_ones_delete","summary":"Delete Structure Custom Group One","description":"DELETE /api/v1/structure_custom_group_ones/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-links-list":{"get":{"operationId":"open_data_pinpoint_structure_links_list","summary":"List Structure Links","description":"GET /api/v1/structure_links","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[structure_links]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"extra_fields[structure_links]","in":"query","required":false,"description":"Include fields that are not always needed, or perhaps computationally expensive","schema":{"type":"array","description":"Include fields that are not always needed, or perhaps computationally expensive"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-links-create-link":{"post":{"operationId":"open_data_pinpoint_structure_links_create_link","summary":"Create Structure Link","description":"POST /api/v1/structure_links","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-links-get-by-id":{"get":{"operationId":"open_data_pinpoint_structure_links_get_by_id","summary":"Fetch Structure Links","description":"GET /api/v1/structure_links/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[structure_links]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"extra_fields[structure_links]","in":"query","required":false,"description":"Include fields that are not always needed, or perhaps computationally expensive","schema":{"type":"array","description":"Include fields that are not always needed, or perhaps computationally expensive"}},{"name":"include","in":"query","required":false,"description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)","schema":{"type":"array","description":"[Include related resources](https://jsonapi.org/format/#fetching-includes)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-links-update-link-by-id":{"post":{"operationId":"open_data_pinpoint_structure_links_update_link_by_id","summary":"Update Structure Link","description":"PUT /api/v1/structure_links/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/structure-links-remove-by-id":{"post":{"operationId":"open_data_pinpoint_structure_links_remove_by_id","summary":"Delete Structure Link","description":"DELETE /api/v1/structure_links/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/users-list-users":{"get":{"operationId":"open_data_pinpoint_users_list_users","summary":"List users","description":"GET /api/v1/users","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"fields[users]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}},{"name":"filter[employee]","in":"query","required":false,"description":"Filter records based on whether the user is an employee of your company","schema":{"type":"boolean","enum":[true,false],"description":"Filter records based on whether the user is an employee of your company"}},{"name":"page[number]","in":"query","required":false,"description":"The page number of records to return","schema":{"type":"integer","default":1,"description":"The page number of records to return"}},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return.","schema":{"type":"integer","default":100,"description":"The number of records to return."}},{"name":"stats[total]","in":"query","required":false,"description":"Include the total number of matched records within the meta key of the response object.","schema":{"type":"string","enum":["count"],"description":"Include the total number of matched records within the meta key of the response object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/users-create-user":{"post":{"operationId":"open_data_pinpoint_users_create_user","summary":"Create User","description":"POST /api/v1/users","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","body"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/users-get-by-id":{"get":{"operationId":"open_data_pinpoint_users_get_by_id","summary":"Fetch users","description":"GET /api/v1/users/{id}","tags":["open-data"],"parameters":[{"name":"subdomain","in":"query","required":true,"description":"Part of the server address: https://{subdomain}.pinpointhq.com","schema":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"}},{"name":"id","in":"query","required":true,"description":"ID of the resource","schema":{"type":"string","description":"ID of the resource"}},{"name":"fields[users]","in":"query","required":false,"description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)","schema":{"type":"array","description":"[Include only specified fields in the response](https://jsonapi.org/format/#fetching-sparse-fieldsets)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:pinpoint/users-remove-user":{"post":{"operationId":"open_data_pinpoint_users_remove_user","summary":"Delete User","description":"DELETE /api/v1/users/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subdomain","id"],"properties":{"subdomain":{"type":"string","description":"Part of the server address: https://{subdomain}.pinpointhq.com"},"id":{"type":"string","description":"ID of the resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}