JAI CRM
Home Documentation API Events and card scanning endpoints

Events and card scanning endpoints

37 endpoints: Sessions, Cards, Visits, Came back and more.

Every endpoint in Events and card scanning: 37 operations across 17 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.

Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.

Cards

GET/api/events/cards

List the cards for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/cards 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/events/cards/{id}

List the cards for an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X GET https://app.jaicrm.ai/api/events/cards/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/events/cards/{id}/duplicates

List the duplicates for an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X GET https://app.jaicrm.ai/api/events/cards/RECORD_ID/duplicates 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/events/cards/unfiled/count

List the count for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/cards/unfiled/count 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/cards

Add to the cards of an exhibition

curl -X POST https://app.jaicrm.ai/api/events/cards 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/cards/{id}/bin

Add to the bin of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/events/cards/RECORD_ID/bin 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/cards/{id}/media

Add to the media of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/events/cards/RECORD_ID/media 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/cards/{id}/merge

Add to the merge of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/events/cards/RECORD_ID/merge 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/cards/file

Add to the file of an exhibition

curl -X POST https://app.jaicrm.ai/api/events/cards/file 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/events/cards/{id}

Change the cards of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X PATCH https://app.jaicrm.ai/api/events/cards/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/events/cards/{id}

Remove from the cards of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X DELETE https://app.jaicrm.ai/api/events/cards/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Events

GET/api/events/

List exhibitions, filtered, sorted and paged

curl -X GET https://app.jaicrm.ai/api/events/ 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/events/{id}

Read one exhibition in full

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X GET https://app.jaicrm.ai/api/events/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/

Create an exhibition

curl -X POST https://app.jaicrm.ai/api/events/ 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/events/{id}

Change an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X PATCH https://app.jaicrm.ai/api/events/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/events/{id}

Delete an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X DELETE https://app.jaicrm.ai/api/events/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Sessions

GET/api/events/sessions/mine

List the mine for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/sessions/mine 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/sessions

Add to the sessions of an exhibition

curl -X POST https://app.jaicrm.ai/api/events/sessions 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/sessions/{id}/close

Add to the close of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/events/sessions/RECORD_ID/close 
  -H 'Authorization: Bearer YOUR_API_KEY'

Costs

POST/api/events/{id}/costs

Add to the costs of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/events/RECORD_ID/costs 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/events/costs/{id}

Change the costs of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X PATCH https://app.jaicrm.ai/api/events/costs/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/events/costs/{id}

Remove from the costs of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X DELETE https://app.jaicrm.ai/api/events/costs/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Roi

GET/api/events/roi

List the roi for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/roi 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/events/roi/team

List the team for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/roi/team 
  -H 'Authorization: Bearer YOUR_API_KEY'

Stall

GET/api/events/stall/can-unlock

List the can unlock for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/stall/can-unlock 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/events/stall/unlock

Add to the unlock of an exhibition

curl -X POST https://app.jaicrm.ai/api/events/stall/unlock 
  -H 'Authorization: Bearer YOUR_API_KEY'

Visits

POST/api/events/{id}/visits

Add to the visits of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/events/RECORD_ID/visits 
  -H 'Authorization: Bearer YOUR_API_KEY'

Came back

GET/api/events/{id}/came-back

List the came back for an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X GET https://app.jaicrm.ai/api/events/RECORD_ID/came-back 
  -H 'Authorization: Bearer YOUR_API_KEY'

Report

GET/api/events/{id}/report

List the report for an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X GET https://app.jaicrm.ai/api/events/RECORD_ID/report 
  -H 'Authorization: Bearer YOUR_API_KEY'

Report.pdf

GET/api/events/{id}/report.pdf

List the report.pdf for an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X GET https://app.jaicrm.ai/api/events/RECORD_ID/report.pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

Roi.pdf

GET/api/events/roi.pdf

List the roi.pdf for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/roi.pdf 
  -H 'Authorization: Bearer YOUR_API_KEY'

Figures

GET/api/events/figures

List the figures for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/figures 
  -H 'Authorization: Bearer YOUR_API_KEY'

Lookup

POST/api/events/lookup

Add to the lookup of an exhibition

curl -X POST https://app.jaicrm.ai/api/events/lookup 
  -H 'Authorization: Bearer YOUR_API_KEY'

Search

GET/api/events/search

List the search for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/search 
  -H 'Authorization: Bearer YOUR_API_KEY'

Scanners

GET/api/events/scanners

List the scanners for an exhibition

curl -X GET https://app.jaicrm.ai/api/events/scanners 
  -H 'Authorization: Bearer YOUR_API_KEY'

Review

GET/api/events/{id}/review

List the review for an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X GET https://app.jaicrm.ai/api/events/RECORD_ID/review 
  -H 'Authorization: Bearer YOUR_API_KEY'

Promote

POST/api/events/{id}/promote

Add to the promote of an exhibition

ParameterTypeRequiredNotes
idstringRequiredThe record’s id.
curl -X POST https://app.jaicrm.ai/api/events/RECORD_ID/promote 
  -H 'Authorization: Bearer YOUR_API_KEY'

Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.