id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
7c99318c-13e3-428a-98c9-1d3602d179d7/78c7c3be-9548-49c3-83f8-89ac62660048/0/0
IoTDb
Internet of Things (Smart Device Product) Database - Get product information for smart/iot devices. See better documentation at https://iotdb.com/api/docs
null
getFiles
List the files.
200
null
{"data": [{"id": "8cbb43fe-4cdf-4991-8352-c461779cec02", "storage": "local", "filename_disk": "a88c3b72-ac58-5436-a4ec-b2858531333a.jpg", "filename_download": "avatar.jpg", "title": "User Avatar", "type": "image/jpeg", "folder": "", "uploaded_by": "", "uploaded_on": "2019-12-03T00:10:15+00:00", "modified_by": "", "modified_on": "", "charset": "binary", "filesize": 137862, "width": 800, "height": 838, "duration": 0, "embed": "", "description": "", "location": "", "tags": [], "metadata": {}, "storage_divider": ""}]}
{"type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "x-collection": "directus_files", "properties": {"id": {"description": "Unique identifier for the file.", "type": "string"}, "storage": {"description": "Where the file is stored. Either `local` for the local filesystem or the name of the storage adapter (for example `s3`).", "type": "string"}, "filename_disk": {"description": "Name of the file on disk. By default, Directus uses a random hash for the filename.", "type": "string"}, "filename_download": {"description": "How you want to the file to be named when it's being downloaded.", "type": "string"}, "title": {"description": "Title for the file. Is extracted from the filename on upload, but can be edited by the user.", "type": "string"}, "type": {"description": "MIME type of the file.", "type": "string"}, "folder": {"description": "Virtual folder where this file resides in.", "oneOf": [{"type": "string"}, {"type": "object", "x-collection": "directus_files", "properties": {"id": {"description": "Unique identifier for the folder.", "type": "string"}, "name": {"description": "Name of the folder.", "type": "string"}, "parent": {"description": "Unique identifier of the parent folder. This allows for nested folders.", "type": ["object", "null"]}}}]}, "uploaded_by": {"description": "Who uploaded the file.", "oneOf": [{"type": "string"}, {"type": "object", "x-collection": "directus_users", "properties": {"id": {"description": "Unique identifier for the user.", "type": "string"}}}]}, "uploaded_on": {"description": "When the file was uploaded.", "type": "string", "format": "date-time"}, "modified_by": {"oneOf": [{"type": "string", "format": "uuid"}, {"type": "object", "x-collection": "directus_users", "properties": {"id": {"description": "Unique identifier for the user.", "type": "string"}}}]}, "modified_on": {"type": "string", "format": "timestamp"}, "charset": {"description": "Character set of the file.", "type": ["string", "null"]}, "filesize": {"description": "Size of the file in bytes.", "type": "integer"}, "width": {"description": "Width of the file in pixels. Only applies to images.", "type": ["integer", "null"]}, "height": {"description": "Height of the file in pixels. Only applies to images.", "type": ["integer", "null"]}, "duration": {"description": "Duration of the file in seconds. Only applies to audio and video.", "type": ["integer", "null"]}, "embed": {"description": "Where the file was embedded from.", "type": ["string", "null"]}, "description": {"description": "Description for the file.", "type": ["string", "null"]}, "location": {"description": "Where the file was created. Is automatically populated based on EXIF data for images.", "type": ["string", "null"]}, "tags": {"description": "Tags for the file. Is automatically populated based on EXIF data for images.", "type": ["array", "null"], "items": {"type": "string"}}, "metadata": {"description": "IPTC, EXIF, and ICC metadata extracted from file", "type": ["object", "null"]}, "storage_divider": {"type": "string"}}}}}}
7c99318c-13e3-428a-98c9-1d3602d179d7/78c7c3be-9548-49c3-83f8-89ac62660048/1/0
IoTDb
Internet of Things (Smart Device Product) Database - Get product information for smart/iot devices. See better documentation at https://iotdb.com/api/docs
null
getFiles
List the files.
401
null
{"error": {"code": 0, "message": ""}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "message": {"type": "string"}}}}}
8cb847f7-3970-427b-8634-4ce50e5c412b/19c1301f-0c95-411b-9579-4bfef64f7a15/0/0
ESWIPE
WebAPI for mobile application
null
/Quiz/{id}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectQuizCode": "", "subjectQuizQty": "", "subjectQuizAnswer": "", "subjectQuizCorrectAnswer": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}, "subjectQuizAnswer": {"type": ["string", "null"]}, "subjectQuizCorrectAnswer": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/19c1301f-0c95-411b-9579-4bfef64f7a15/1/0
ESWIPE
WebAPI for mobile application
null
/Quiz/{id}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectQuizCode": "", "subjectQuizQty": "", "subjectQuizAnswer": "", "subjectQuizCorrectAnswer": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}, "subjectQuizAnswer": {"type": ["string", "null"]}, "subjectQuizCorrectAnswer": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/ec126e46-f27d-4bd2-ac83-76a8dc7b10b3/0/0
ESWIPE
WebAPI for mobile application
null
/Teacher/{id}
200
null
{"id": 0, "teacherNumber": 0, "name": "", "section": "", "username": "", "password": "", "userRole": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "teacherNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/ec126e46-f27d-4bd2-ac83-76a8dc7b10b3/1/0
ESWIPE
WebAPI for mobile application
null
/Teacher/{id}
200
null
{"id": 0, "teacherNumber": 0, "name": "", "section": "", "username": "", "password": "", "userRole": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "teacherNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/9da04d9b-bc1f-4be8-8f12-dda533548c3f/0/0
ESWIPE
WebAPI for mobile application
null
/Quiz
200
null
[{"id": 0, "dateCreated": "", "createdBy": "", "subjectQuizCode": "", "subjectQuizQty": "", "subjectQuizAnswer": "", "subjectQuizCorrectAnswer": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}, "subjectQuizAnswer": {"type": ["string", "null"]}, "subjectQuizCorrectAnswer": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/9da04d9b-bc1f-4be8-8f12-dda533548c3f/1/0
ESWIPE
WebAPI for mobile application
null
/Quiz
200
null
[{"id": 0, "dateCreated": "", "createdBy": "", "subjectQuizCode": "", "subjectQuizQty": "", "subjectQuizAnswer": "", "subjectQuizCorrectAnswer": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}, "subjectQuizAnswer": {"type": ["string", "null"]}, "subjectQuizCorrectAnswer": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/5d835c9c-324b-4ecf-b4ba-4017113642a5/0/0
ESWIPE
WebAPI for mobile application
null
/Quiz/SubjectQuizCode/{subjectQuizCode}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectQuizCode": "", "subjectQuizQty": "", "subjectQuizAnswer": "", "subjectQuizCorrectAnswer": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}, "subjectQuizAnswer": {"type": ["string", "null"]}, "subjectQuizCorrectAnswer": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/5d835c9c-324b-4ecf-b4ba-4017113642a5/1/0
ESWIPE
WebAPI for mobile application
null
/Quiz/SubjectQuizCode/{subjectQuizCode}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectQuizCode": "", "subjectQuizQty": "", "subjectQuizAnswer": "", "subjectQuizCorrectAnswer": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}, "subjectQuizAnswer": {"type": ["string", "null"]}, "subjectQuizCorrectAnswer": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/295abc3a-a44e-4b89-8b3d-3d82c641136e/0/0
ESWIPE
WebAPI for mobile application
null
/Teacher/TeacherNumber/{teacherNumber}
200
null
{"id": 0, "teacherNumber": 0, "name": "", "section": "", "username": "", "password": "", "userRole": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "teacherNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/295abc3a-a44e-4b89-8b3d-3d82c641136e/1/0
ESWIPE
WebAPI for mobile application
null
/Teacher/TeacherNumber/{teacherNumber}
200
null
{"id": 0, "teacherNumber": 0, "name": "", "section": "", "username": "", "password": "", "userRole": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "teacherNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/13ad5226-8f6f-4f04-98c3-dfadcea63807/0/0
ESWIPE
WebAPI for mobile application
null
/Teacher
200
null
[{"id": 0, "teacherNumber": 0, "name": "", "section": "", "username": "", "password": "", "userRole": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "teacherNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/13ad5226-8f6f-4f04-98c3-dfadcea63807/1/0
ESWIPE
WebAPI for mobile application
null
/Teacher
200
null
[{"id": 0, "teacherNumber": 0, "name": "", "section": "", "username": "", "password": "", "userRole": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "teacherNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/f336583f-d685-44f5-8b6f-801c522bc211/0/0
ESWIPE
WebAPI for mobile application
null
/Student/{id}
200
null
{"id": 0, "studentNumber": 0, "name": "", "year": "", "section": "", "username": "", "password": "", "userRole": "", "subjectsCode": "", "quizCode": "", "quizScore": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "studentNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "year": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}, "subjectsCode": {"type": ["string", "null"]}, "quizCode": {"type": ["string", "null"]}, "quizScore": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/f336583f-d685-44f5-8b6f-801c522bc211/1/0
ESWIPE
WebAPI for mobile application
null
/Student/{id}
200
null
{"id": 0, "studentNumber": 0, "name": "", "year": "", "section": "", "username": "", "password": "", "userRole": "", "subjectsCode": "", "quizCode": "", "quizScore": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "studentNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "year": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}, "subjectsCode": {"type": ["string", "null"]}, "quizCode": {"type": ["string", "null"]}, "quizScore": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/0cfd5c0e-ea09-4294-bd48-50e264c16c49/0/0
ESWIPE
WebAPI for mobile application
null
/Student
200
null
[{"id": 0, "studentNumber": 0, "name": "", "year": "", "section": "", "username": "", "password": "", "userRole": "", "subjectsCode": "", "quizCode": "", "quizScore": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "studentNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "year": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}, "subjectsCode": {"type": ["string", "null"]}, "quizCode": {"type": ["string", "null"]}, "quizScore": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/0cfd5c0e-ea09-4294-bd48-50e264c16c49/1/0
ESWIPE
WebAPI for mobile application
null
/Student
200
null
[{"id": 0, "studentNumber": 0, "name": "", "year": "", "section": "", "username": "", "password": "", "userRole": "", "subjectsCode": "", "quizCode": "", "quizScore": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "studentNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "year": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}, "subjectsCode": {"type": ["string", "null"]}, "quizCode": {"type": ["string", "null"]}, "quizScore": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/8958619a-320c-4a80-aa5b-357c864a957e/0/0
ESWIPE
WebAPI for mobile application
null
/Module/{id}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectCode": "", "subjectQuizCode": "", "subjectQuizQty": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectCode": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/8958619a-320c-4a80-aa5b-357c864a957e/1/0
ESWIPE
WebAPI for mobile application
null
/Module/{id}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectCode": "", "subjectQuizCode": "", "subjectQuizQty": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectCode": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/898f6f60-b9d9-4225-ba86-8e5d73f0438f/0/0
ESWIPE
WebAPI for mobile application
null
/Module/SubjectQuizCode/{subjectQuizCode}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectCode": "", "subjectQuizCode": "", "subjectQuizQty": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectCode": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/898f6f60-b9d9-4225-ba86-8e5d73f0438f/1/0
ESWIPE
WebAPI for mobile application
null
/Module/SubjectQuizCode/{subjectQuizCode}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectCode": "", "subjectQuizCode": "", "subjectQuizQty": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectCode": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/df311cb6-8de2-4a04-ab40-9cb1ea99104d/0/0
ESWIPE
WebAPI for mobile application
null
/Module
200
null
[{"id": 0, "dateCreated": "", "createdBy": "", "subjectCode": "", "subjectQuizCode": "", "subjectQuizQty": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectCode": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/df311cb6-8de2-4a04-ab40-9cb1ea99104d/1/0
ESWIPE
WebAPI for mobile application
null
/Module
200
null
[{"id": 0, "dateCreated": "", "createdBy": "", "subjectCode": "", "subjectQuizCode": "", "subjectQuizQty": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectCode": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/5dc1aafe-841f-426f-939a-177e88a6c15d/0/0
ESWIPE
WebAPI for mobile application
null
/Student/StudentNumber/{studentNumber}
200
null
{"id": 0, "studentNumber": 0, "name": "", "year": "", "section": "", "username": "", "password": "", "userRole": "", "subjectsCode": "", "quizCode": "", "quizScore": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "studentNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "year": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}, "subjectsCode": {"type": ["string", "null"]}, "quizCode": {"type": ["string", "null"]}, "quizScore": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/5dc1aafe-841f-426f-939a-177e88a6c15d/1/0
ESWIPE
WebAPI for mobile application
null
/Student/StudentNumber/{studentNumber}
200
null
{"id": 0, "studentNumber": 0, "name": "", "year": "", "section": "", "username": "", "password": "", "userRole": "", "subjectsCode": "", "quizCode": "", "quizScore": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "studentNumber": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "name": {"type": ["string", "null"]}, "year": {"type": ["string", "null"]}, "section": {"type": ["string", "null"]}, "username": {"type": ["string", "null"]}, "password": {"type": ["string", "null"]}, "userRole": {"type": ["string", "null"]}, "subjectsCode": {"type": ["string", "null"]}, "quizCode": {"type": ["string", "null"]}, "quizScore": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/56eaf9e8-017f-4709-8f11-1834c1414a4b/0/0
ESWIPE
WebAPI for mobile application
null
/Module/SubjectCode/{subjectCode}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectCode": "", "subjectQuizCode": "", "subjectQuizQty": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectCode": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/56eaf9e8-017f-4709-8f11-1834c1414a4b/1/0
ESWIPE
WebAPI for mobile application
null
/Module/SubjectCode/{subjectCode}
200
null
{"id": 0, "dateCreated": "", "createdBy": "", "subjectCode": "", "subjectQuizCode": "", "subjectQuizQty": ""}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "dateCreated": {"type": ["string", "null"]}, "createdBy": {"type": ["string", "null"]}, "subjectCode": {"type": ["string", "null"]}, "subjectQuizCode": {"type": ["string", "null"]}, "subjectQuizQty": {"type": ["string", "null"]}}, "additionalProperties": false}
8cb847f7-3970-427b-8634-4ce50e5c412b/33fd7829-74ff-47a7-a106-abdfe9f70fa6/0/0
ESWIPE
WebAPI for mobile application
null
/WeatherForecast
200
null
[{"date": "", "temperatureC": 0, "temperatureF": 0, "summary": ""}]
{"type": "array", "items": {"type": "object", "properties": {"date": {"type": "string", "format": "date-time"}, "temperatureC": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "temperatureF": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "summary": {"type": ["string", "null"]}}, "additionalProperties": false}}
8cb847f7-3970-427b-8634-4ce50e5c412b/33fd7829-74ff-47a7-a106-abdfe9f70fa6/1/0
ESWIPE
WebAPI for mobile application
null
/WeatherForecast
200
null
[{"date": "", "temperatureC": 0, "temperatureF": 0, "summary": ""}]
{"type": "array", "items": {"type": "object", "properties": {"date": {"type": "string", "format": "date-time"}, "temperatureC": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "temperatureF": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "summary": {"type": ["string", "null"]}}, "additionalProperties": false}}
5c0a1cef-41dc-448d-b03b-301d1f46337d/7da6030f-13a1-4cb9-839c-0506c34f2987/0/0
GSMArenaParser
This is an easy to use GSMArena Parser API
6.2
Get all devices
This endpoint returns all available devices in db including their specifications
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
7f67b8d8-c5ca-4b91-9086-5fbabc8382c7/1da9be45-98c0-4050-ae40-33b1e222352a/0/0
QR code JWT Authentication
The API is designed to allow devices to securely authenticate with a server by scanning a QR code and JWT.
null
Refresh JWT token
This endpoint will regenerate a fresh JWT authentication token key for the deivice after a certain period for security reasons.
200
New Example
{"authentication_key": "string"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"authentication_key": {"type": "string"}}, "required": ["authentication_key"]}
7f67b8d8-c5ca-4b91-9086-5fbabc8382c7/c40d8436-5f19-42a4-946a-211dfbd5eada/0/0
QR code JWT Authentication
The API is designed to allow devices to securely authenticate with a server by scanning a QR code and JWT.
null
Scan QR code to generate API key
This endpoint is used to scan a QR code and generate an API key.
200
New Example
{"api_auth_url": "string", "authentication_reference": "string", "authentication_key": "string"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"api_auth_url": {"type": "string"}, "authentication_reference": {"type": "string"}, "authentication_key": {"type": "string"}}, "required": ["api_auth_url", "authentication_key", "authentication_reference"]}
8bd27b3e-11d5-49c0-a74b-b3fefa21b034/79c410ca-a9f1-4216-9242-ecfd89fce56b/0/0
CellPhones
Welcome to the GSMarena API! Our API allows you to easily access and consume the vast array of data available on the GSMarena website. With our API, you can access detailed information about any phone or tablet, including technical specifications, images, and more. With the GSMarena API, you can quickly and easily: • Retrieve detailed information about any phone or tablet • Access images of any device • Get full specifications and features of any device • Check prices, ratings, and re...
9.1
GetPhonesByBrandId
Use this end point to load all phone ids for a specific brand. get the brand id from the endpoint GetBrands
200
Response
[1859, 1860, 1861, 1972, 2083, 2194, 2305, 2416, 2527, 2638, 2749, 2860, 2971, 2972, 3083, 3194, 3305, 3416, 3527, 3638, 3749, 3860, 3971, 4082, 4083, 4194, 4305, 4416, 4527, 4638, 4749, 4860, 4971, 5082, 5193, 5194, 5305, 5416, 5527, 5638, 5749, 5860, 5971, 6082, 6193, 6304, 6305, 6416, 6521, 6532, 6543, 6554, 6565, 6576, 6587, 6598, 6609, 6610, 6621, 6632, 6643, 6654, 6665, 6676, 6687, 6698, 6709, 6720, 6721, 6732, 6743, 6754, 6765, 6776, 6787, 6798, 6809, 6820, 6831, 6832, 6843, 6854, 6865, 6876, 6887, 6898, 6909, 6920, 6931, 6942, 6943, 6954, 6965, 6976, 6987, 6998, 7009, 7020, 7031, 7042]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "integer"}}
8bd27b3e-11d5-49c0-a74b-b3fefa21b034/21471abd-0c0f-4cc3-9c34-a58ea603aa1f/0/0
CellPhones
Welcome to the GSMarena API! Our API allows you to easily access and consume the vast array of data available on the GSMarena website. With our API, you can access detailed information about any phone or tablet, including technical specifications, images, and more. With the GSMarena API, you can quickly and easily: • Retrieve detailed information about any phone or tablet • Access images of any device • Get full specifications and features of any device • Check prices, ratings, and re...
9.1
GetBrands
Load all cell phone brands
200
Response
[{"id": 237, "name": "Acer", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 238, "name": "alcatel", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 239, "name": "Allview", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 240, "name": "Amazon", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 241, "name": "Amoi", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 242, "name": "Apple", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 243, "name": "Archos", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 244, "name": "Asus", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 245, "name": "AT&T", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 246, "name": "Benefon", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 247, "name": "BenQ", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 248, "name": "BenQ-Siemens", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 249, "name": "Bird", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 250, "name": "BlackBerry", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 251, "name": "Blackview", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 252, "name": "BLU", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 253, "name": "Bosch", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 254, "name": "BQ", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 255, "name": "Casio", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 256, "name": "Cat", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 257, "name": "Celkon", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 258, "name": "Chea", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 259, "name": "Coolpad", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 260, "name": "Dell", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 261, "name": "Emporia", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 262, "name": "Energizer", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 263, "name": "Ericsson", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 264, "name": "Eten", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 265, "name": "Fairphone", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 266, "name": "Fujitsu Siemens", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 267, "name": "Garmin-Asus", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 268, "name": "Gigabyte", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 269, "name": "Gionee", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 270, "name": "Google", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 271, "name": "Haier", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 272, "name": "Honor", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 273, "name": "HP", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 274, "name": "HTC", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 275, "name": "Huawei", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 276, "name": "i-mate", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 277, "name": "i-mobile", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 278, "name": "Icemobile", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 279, "name": "Infinix", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 280, "name": "Innostream", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 281, "name": "iNQ", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 282, "name": "Intex", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 283, "name": "Jolla", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 284, "name": "Karbonn", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 285, "name": "Kyocera", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 286, "name": "Lava", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 287, "name": "LeEco", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 288, "name": "Lenovo", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 289, "name": "LG", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 290, "name": "Maxon", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 291, "name": "Maxwest", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 292, "name": "Meizu", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 293, "name": "Micromax", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 294, "name": "Microsoft", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 295, "name": "Mitac", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 296, "name": "Mitsubishi", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 297, "name": "Modu", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 298, "name": "Motorola", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 299, "name": "MWg", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 300, "name": "NEC", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 301, "name": "Neonode", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 302, "name": "NIU", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 303, "name": "Nokia", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 304, "name": "Nothing", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 305, "name": "Nvidia", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 306, "name": "O2", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 307, "name": "OnePlus", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 308, "name": "Oppo", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 309, "name": "Orange", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 310, "name": "Palm", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 311, "name": "Panasonic", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 312, "name": "Pantech", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 313, "name": "Parla", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 314, "name": "Philips", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 315, "name": "Plum", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 316, "name": "Posh", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 317, "name": "Prestigio", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 318, "name": "QMobile", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 319, "name": "Qtek", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 320, "name": "Razer", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 321, "name": "Realme", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 322, "name": "Sagem", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 323, "name": "Samsung", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 324, "name": "Sendo", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 325, "name": "Sewon", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 326, "name": "Sharp", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 327, "name": "Siemens", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 328, "name": "Sonim", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 329, "name": "Sony", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 330, "name": "Sony Ericsson", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 331, "name": "Spice", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 332, "name": "T-Mobile", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 333, "name": "TCL", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 334, "name": "Tecno", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 335, "name": "Tel.Me.", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 336, "name": "Telit", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 337, "name": "Thuraya", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 338, "name": "Toshiba", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 339, "name": "Ulefone", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 340, "name": "Unnecto", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 341, "name": "Vertu", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 342, "name": "verykool", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 343, "name": "vivo", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 344, "name": "VK Mobile", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 345, "name": "Vodafone", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 346, "name": "Wiko", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 347, "name": "WND", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 348, "name": "XCute", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 349, "name": "Xiaomi", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 350, "name": "XOLO", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 351, "name": "Yezz", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 352, "name": "Yota", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 353, "name": "YU", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 354, "name": "ZTE", "workingPhones": null, "brandPhones": [], "phones": []}, {"id": 355, "name": "Doogee", "workingPhones": null, "brandPhones": [], "phones": []}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "name": {"type": "string"}, "workingPhones": {"type": "null"}, "brandPhones": {"type": "array"}, "phones": {"type": "array"}}, "required": ["brandPhones", "id", "name", "phones", "workingPhones"]}}
8bd27b3e-11d5-49c0-a74b-b3fefa21b034/56f00572-8be8-407f-a0fd-b5aed39f29f1/0/0
CellPhones
Welcome to the GSMarena API! Our API allows you to easily access and consume the vast array of data available on the GSMarena website. With our API, you can access detailed information about any phone or tablet, including technical specifications, images, and more. With the GSMarena API, you can quickly and easily: • Retrieve detailed information about any phone or tablet • Access images of any device • Get full specifications and features of any device • Check prices, ratings, and re...
9.1
GetPhoneDetails
Get all phone specifications & photos by phone id, get the phone id from the endpoint GetPhonesByBrandId
200
Response
{"id": 1859, "brandId": 237, "title": "Acer Chromebook Tab 10", "thumbnail": "https://fdn2.gsmarena.com/vv/bigpic/acer-chromebook-tab-10.jpg", "releaseDate": "Released 2018, July", "dimension": "544.3g, 9.9mm thickness", "os": "Chrome OS", "storage": "32GB storage, microSDXC", "url": "https://www.gsmarena.com/acer_chromebook_tab_10-9139.php", "displaySize": "9.7\"", "resolution": "1536x2048 pixels", "ram": "4", "chipset": "Rockchip RK3399", "batterySize": "4500", "batteryType": "Li-Po", "photosUrl": "https://www.gsmarena.com/acer_chromebook_tab_10-pictures-9139.php", "price": null, "brand": null, "phonePhotoes": [{"id": 3024, "phoneId": 1859, "photo": "https://fdn2.gsmarena.com/vv/pics/acer/acer-chromebook-tab-10-D651N-1.jpg"}, {"id": 3025, "phoneId": 1859, "photo": "https://fdn2.gsmarena.com/vv/pics/acer/acer-chromebook-tab-10-D651N-2.jpg"}], "phoneSpecs": [{"id": 72310, "specId": 16, "phoneId": 1859, "val": "N/A", "specTitle": "net2g", "spec": null}, {"id": 72311, "specId": 43, "phoneId": 1859, "val": "Up to 9 h (multimedia)", "specTitle": "battalktime1", "spec": null}, {"id": 72312, "specId": 42, "phoneId": 1859, "val": "Li-Po 4500 mAh, non-removable (34 Wh)", "specTitle": "batdescription1", "spec": null}, {"id": 72313, "specId": 41, "phoneId": 1859, "val": "Accelerometer", "specTitle": "sensors", "spec": null}, {"id": 72314, "specId": 40, "phoneId": 1859, "val": "USB Type-C 3.1", "specTitle": "usb", "spec": null}, {"id": 72315, "specId": 39, "phoneId": 1859, "val": "No", "specTitle": "radio", "spec": null}, {"id": 72316, "specId": 38, "phoneId": 1859, "val": "No", "specTitle": "nfc", "spec": null}, {"id": 72317, "specId": 37, "phoneId": 1859, "val": "4.1, A2DP, LE", "specTitle": "bluetooth", "spec": null}, {"id": 72318, "specId": 36, "phoneId": 1859, "val": "Wi-Fi 802.11 b/g/n/ac, dual-band, Wi-Fi Direct", "specTitle": "wlan", "spec": null}, {"id": 72319, "specId": 35, "phoneId": 1859, "val": "2 MP", "specTitle": "cam2modules", "spec": null}, {"id": 72320, "specId": 34, "phoneId": 1859, "val": "720p", "specTitle": "cam1video", "spec": null}, {"id": 72321, "specId": 33, "phoneId": 1859, "val": "5 MP", "specTitle": "cam1modules", "spec": null}, {"id": 72322, "specId": 32, "phoneId": 1859, "val": "32GB 4GB RAM", "specTitle": "internalmemory", "spec": null}, {"id": 72323, "specId": 31, "phoneId": 1859, "val": "microSDXC (dedicated slot)", "specTitle": "memoryslot", "spec": null}, {"id": 72324, "specId": 30, "phoneId": 1859, "val": "Hexa-core (4x Cortex-A53 & 2x Cortex-A72)", "specTitle": "cpu", "spec": null}, {"id": 72325, "specId": 29, "phoneId": 1859, "val": "Rockchip RK3399", "specTitle": "chipset", "spec": null}, {"id": 72326, "specId": 28, "phoneId": 1859, "val": "Chrome OS", "specTitle": "os", "spec": null}, {"id": 72327, "specId": 27, "phoneId": 1859, "val": "1536 x 2048 pixels, 4:3 ratio (~264 ppi density)", "specTitle": "displayresolution", "spec": null}, {"id": 72328, "specId": 26, "phoneId": 1859, "val": "9.7 inches, 291.4 cm2 (~71.0% screen-to-body ratio)", "specTitle": "displaysize", "spec": null}, {"id": 72329, "specId": 25, "phoneId": 1859, "val": "IPS LCD", "specTitle": "displaytype", "spec": null}, {"id": 72330, "specId": 24, "phoneId": 1859, "val": "Stylus", "specTitle": "bodyother", "spec": null}, {"id": 72331, "specId": 23, "phoneId": 1859, "val": "No", "specTitle": "sim", "spec": null}, {"id": 72332, "specId": 22, "phoneId": 1859, "val": "544.3 g (1.20 lb)", "specTitle": "weight", "spec": null}, {"id": 72333, "specId": 21, "phoneId": 1859, "val": "238.3 x 172.2 x 9.9 mm (9.38 x 6.78 x 0.39 in)", "specTitle": "dimensions", "spec": null}, {"id": 72334, "specId": 20, "phoneId": 1859, "val": "Available. Released 2018, July", "specTitle": "status", "spec": null}, {"id": 72335, "specId": 19, "phoneId": 1859, "val": "2018, March", "specTitle": "year", "spec": null}, {"id": 72336, "specId": 18, "phoneId": 1859, "val": "No", "specTitle": "edge", "spec": null}, {"id": 72337, "specId": 17, "phoneId": 1859, "val": "No", "specTitle": "gprstext", "spec": null}, {"id": 72338, "specId": 44, "phoneId": 1859, "val": "Black, Blue", "specTitle": "colors", "spec": null}, {"id": 72339, "specId": 45, "phoneId": 1859, "val": "About 330 EUR", "specTitle": "price", "spec": null}], "variants": []}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"id": {"type": "integer"}, "brandId": {"type": "integer"}, "title": {"type": "string"}, "thumbnail": {"type": "string"}, "releaseDate": {"type": "string"}, "dimension": {"type": "string"}, "os": {"type": "string"}, "storage": {"type": "string"}, "url": {"type": "string"}, "displaySize": {"type": "string"}, "resolution": {"type": "string"}, "ram": {"type": "string"}, "chipset": {"type": "string"}, "batterySize": {"type": "string"}, "batteryType": {"type": "string"}, "photosUrl": {"type": "string"}, "price": {"type": "null"}, "brand": {"type": "null"}, "phonePhotoes": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "phoneId": {"type": "integer"}, "photo": {"type": "string"}}, "required": ["id", "phoneId", "photo"]}}, "phoneSpecs": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "specId": {"type": "integer"}, "phoneId": {"type": "integer"}, "val": {"type": "string"}, "specTitle": {"type": "string"}, "spec": {"type": "null"}}, "required": ["id", "phoneId", "spec", "specId", "specTitle", "val"]}}, "variants": {"type": "array"}}, "required": ["batterySize", "batteryType", "brand", "brandId", "chipset", "dimension", "displaySize", "id", "os", "phonePhotoes", "phoneSpecs", "photosUrl", "price", "ram", "releaseDate", "resolution", "storage", "thumbnail", "title", "url", "variants"]}
59836c85-7996-42b5-9c87-71851a3de565/75bbda2f-c8f8-4209-86a5-f2d18ade08bc/0/0
Mobile Phones
Mobile Phones API provides RESTful endpoints to fetch list of mobile brands, list of mobile devices within a brand, specification details for each device and a search endpoint. We host our api on Cloudflare servers to make sure minimal latency with its edge technology and 100s of server across the globe. Edge computing is a networking philosophy focused on bringing computing as close to the source of data as possible in order to reduce latency and bandwidth use. In simpler terms, edge compu...
9
listBrands
You can get a list of all mobile phone brands using this endpoint
200
null
[{"id": 1, "name": "Nokia"}]
{"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "number"}, "name": {"type": "string"}}}}
59836c85-7996-42b5-9c87-71851a3de565/5e604df0-990d-4532-a9de-8d0068e981de/0/0
Mobile Phones
Mobile Phones API provides RESTful endpoints to fetch list of mobile brands, list of mobile devices within a brand, specification details for each device and a search endpoint. We host our api on Cloudflare servers to make sure minimal latency with its edge technology and 100s of server across the globe. Edge computing is a networking philosophy focused on bringing computing as close to the source of data as possible in order to reduce latency and bandwidth use. In simpler terms, edge compu...
9
getPhonesByBrand
You can list all phones under a given brand
200
null
{"brand_id": 1, "brand_name": "Nokia", "id": "nokia_c12_pro-12184", "phone_name": "C12 Pro", "image_url": "https://fdn2.gsmarena.com/vv/bigpic/nokia-c12.jpg", "description": "Nokia C12 Pro Android smartphone. Announced Mar 2023. Features 6.3\u2033 display, Unisoc SC9863A1 chipset, 4000 mAh battery, 64 GB storage, 3 GB RAM, Scratch-resistant glass."}
{"type": "object", "required": ["brand_id", "brand_name", "id", "phone_name", "image_url", "description"], "properties": {"brand_id": {"type": "number"}, "brand_name": {"type": "string"}, "id": {"type": "string"}, "phone_name": {"type": "string"}, "image_url": {"type": "string"}, "description": {"type": "string"}}}
59836c85-7996-42b5-9c87-71851a3de565/6b60b0f0-c140-434e-86b0-8dc9a1b31073/0/0
Mobile Phones
Mobile Phones API provides RESTful endpoints to fetch list of mobile brands, list of mobile devices within a brand, specification details for each device and a search endpoint. We host our api on Cloudflare servers to make sure minimal latency with its edge technology and 100s of server across the globe. Edge computing is a networking philosophy focused on bringing computing as close to the source of data as possible in order to reduce latency and bandwidth use. In simpler terms, edge compu...
9
getPhoneDetails
Get Phone Specification & Other Details
200
null
{"spotlight": {"releaseDate": "Released 2018, September 21", "body": "208g, 7.7mm thickness", "os": "iOS 12, up to iOS 16.4", "storage": "64GB/256GB/512GB storage, no card slot", "display_size": "6.5\"", "display_resolution": "1242x2688 pixels", "camera_pixels": "12 MP", "video_pixels": "2160p", "ram_size": "4 GB RAM", "chipset": "Apple A12 Bionic", "battery_size": "3174 mAh", "battery_type": "Li-Ion", "popularity": " 21%"}, "all_specs": {"Network": [{"title": "Technology", "info": "GSM / CDMA / HSPA / EVDO / LTE"}, {"title": "2G bands", "info": "GSM 850 / 900 / 1800 / 1900 - SIM 1 & SIM 2 (dual-SIM) - for China"}, {"title": " ", "info": "CDMA 800 / 1900 "}, {"title": "3G bands", "info": "HSDPA 850 / 900 / 1700(AWS) / 1900 / 2100 "}, {"title": " ", "info": "CDMA2000 1xEV-DO "}, {"title": "4G bands", "info": "1, 2, 3, 4, 5, 7, 8, 12, 13, 14, 17, 18, 19, 20, 25, 26, 28, 29, 30, 32, 34, 38, 39, 40, 41, 46, 66 - A2101"}, {"title": " ", "info": "1, 2, 3, 4, 5, 7, 8, 12, 13, 14, 17, 18, 19, 20, 25, 26, 29, 30, 32, 34, 38, 39, 40, 41, 46, 66, 71 - A1921, A2104"}, {"title": "Speed", "info": "HSPA 42.2/5.76 Mbps, LTE-A (4CA) Cat16 1024/150 Mbps, EV-DO Rev.A 3.1 Mbps"}], "Launch": [{"title": "Announced", "info": "2018, September 12"}, {"title": "Status", "info": "Available. Released 2018, September 21"}], "Body": [{"title": "Dimensions", "info": "157.5 x 77.4 x 7.7 mm (6.20 x 3.05 x 0.30 in)"}, {"title": "Weight", "info": "208 g (7.34 oz)"}, {"title": "Build", "info": "Glass front (Corning-made glass), glass back (Corning-made glass), stainless steel frame"}, {"title": "SIM", "info": "Nano-SIM and eSIM or Dual SIM (Nano-SIM, dual stand-by) - for China"}, {"title": " ", "info": "IP68 dust/water resistant (up to 2m for 30 min)\nApple Pay (Visa, MasterCard, AMEX certified)"}], "Display": [{"title": "Type", "info": "Super Retina OLED, HDR10, Dolby Vision, 625 nits (HBM)"}, {"title": "Size", "info": "6.5 inches, 102.9 cm2 (~84.4% screen-to-body ratio)"}, {"title": "Resolution", "info": "1242 x 2688 pixels, 19.5:9 ratio (~458 ppi density)"}, {"title": "Protection", "info": "Scratch-resistant glass"}, {"title": " ", "info": "3D Touch"}], "Platform": [{"title": "OS", "info": "iOS 12, upgradable to iOS 16.4"}, {"title": "Chipset", "info": "Apple A12 Bionic (7 nm)"}, {"title": "CPU", "info": "Hexa-core (2x2.5 GHz Vortex + 4x1.6 GHz Tempest)"}, {"title": "GPU", "info": "Apple GPU (4-core graphics)"}], "Memory": [{"title": "Card slot", "info": "No"}, {"title": "Internal", "info": "64GB 4GB RAM, 256GB 4GB RAM, 512GB 4GB RAM"}, {"title": " ", "info": "NVMe"}], "Main Camera": [{"title": "Dual", "info": "12 MP, f/1.8, 26mm (wide), 1/2.55\", 1.4\u00b5m, dual pixel PDAF, OIS\n12 MP, f/2.4, 52mm (telephoto), 1/3.4\", 1.0\u00b5m, PDAF, OIS, 2x optical zoom"}, {"title": "Features", "info": "Quad-LED dual-tone flash, HDR (photo/panorama)"}, {"title": "Video", "info": "4K@24/30/60fps, 1080p@30/60/120/240fps, HDR, stereo sound rec."}], "Selfie camera": [{"title": "Single", "info": "7 MP, f/2.2, 32mm (standard)\nSL 3D, (depth/biometrics sensor)"}, {"title": "Features", "info": "HDR"}, {"title": "Video", "info": "1080p@30/60fps, gyro-EIS"}], "Sound": [{"title": "Loudspeaker ", "info": "Yes, with stereo speakers"}, {"title": "3.5mm jack ", "info": "No"}], "Comms": [{"title": "WLAN", "info": "Wi-Fi 802.11 a/b/g/n/ac, dual-band, hotspot"}, {"title": "Bluetooth", "info": "5.0, A2DP, LE"}, {"title": "Positioning", "info": "GPS, GLONASS, GALILEO, QZSS"}, {"title": "NFC", "info": "Yes"}, {"title": "Radio", "info": "No"}, {"title": "USB", "info": "Lightning, USB 2.0"}], "Features": [{"title": "Sensors", "info": "Face ID, accelerometer, gyro, proximity, compass, barometer"}], "Battery": [{"title": "Type", "info": "Li-Ion 3174 mAh, non-removable (12.08 Wh)"}, {"title": "Charging", "info": "15W wired, PD2.0, 50% in 30 min (advertised)\nWireless (Qi)"}], "Misc": [{"title": "Colors", "info": "Space Gray, Silver, Gold"}, {"title": "Models", "info": "A1921, A2101, A2102, A2104, Phone11,6"}, {"title": "SAR", "info": "1.16 W/kg (head) 1.17 W/kg (body) "}, {"title": "SAR EU", "info": "0.99 W/kg (head) 0.99 W/kg (body) "}, {"title": "Price", "info": "About 570 EUR"}], "Tests": [{"title": "Performance", "info": "\nAnTuTu: 353210 (v7)\nGeekBench: 11432 (v4.4)\nGFXBench: 47fps (ES 3.1 onscreen)"}, {"title": "Display", "info": "\nContrast ratio: Infinite (nominal), 4.516 (sunlight)"}, {"title": "Camera", "info": "\nPhoto / Video"}, {"title": "Loudspeaker", "info": "\nVoice 70dB / Noise 74dB / Ring 84dB\n\n"}, {"title": "Audio quality", "info": "\nNoise -93.7dB / Crosstalk -82.8dB"}, {"title": "Battery life", "info": "\n\nEndurance rating 79h\n\n"}, {"title": "", "info": ""}]}}
{"type": "object"}
59836c85-7996-42b5-9c87-71851a3de565/8f248c19-e10a-4aeb-8c41-2cff5889e8da/0/0
Mobile Phones
Mobile Phones API provides RESTful endpoints to fetch list of mobile brands, list of mobile devices within a brand, specification details for each device and a search endpoint. We host our api on Cloudflare servers to make sure minimal latency with its edge technology and 100s of server across the globe. Edge computing is a networking philosophy focused on bringing computing as close to the source of data as possible in order to reduce latency and bandwidth use. In simpler terms, edge compu...
9
searchPhones
Search for phones
200
null
[{"id": "apple_iphone-1827", "score": 8.060360750284897, "terms": [], "match": {}, "brand_name": "Apple", "phone_name": "iPhone", "image_url": "https://fdn2.gsmarena.com/vv/bigpic/apple-iphone.gif", "brand_id": 48}]
{"type": "array", "items": {"type": "object", "required": ["id", "score", "terms", "match", "brand_name", "phone_name", "image_url", "brand_id"], "properties": {"id": {"type": "string"}, "score": {"type": "number"}, "terms": {"type": "array", "items": {"type": "string"}}, "match": {"type": "object"}, "brand_name": {"type": "string"}, "phone_name": {"type": "string"}, "image_url": {"type": "string"}, "brand_id": {"type": "number"}}}}
72ed1d19-3bb2-4ed4-a4f1-e6cd488912fa/d17e87c6-1b78-4b18-952f-36f99d8025ac/0/0
MAC Address to Manufacturer
MAC Address Lookup to find the hardware manufacturer and its postal address of a specific MAC Address
7.9
maclookup
Enter MAC Address (string) to find the manufacturer. MAC Formats Allowed: ('xx-xx-xx-xx-xx-xx', 'xx:xx:xx:xx:xx:xx', 'xxxx.xxxx.xxxx', 'xxxxxxxxxxxx')
200
Example_1
{"message": "Data Found", "data": {"0": {"MAC OUI Number": "14ABC5", "Vendor Manufacturer": "Intel Corporate", "Vendor Address": "Lot 8, Jalan Hi-Tech 2/3 Kulim Kedah MY 09000 "}}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}, "data": {"type": "object", "properties": {"0": {"type": "object", "properties": {"MAC OUI Number": {"type": "string"}, "Vendor Manufacturer": {"type": "string"}, "Vendor Address": {"type": "string"}}, "required": ["MAC OUI Number", "Vendor Address", "Vendor Manufacturer"]}}, "required": ["0"]}}, "required": ["data", "message"]}
72ed1d19-3bb2-4ed4-a4f1-e6cd488912fa/d17e87c6-1b78-4b18-952f-36f99d8025ac/1/0
MAC Address to Manufacturer
MAC Address Lookup to find the hardware manufacturer and its postal address of a specific MAC Address
7.9
maclookup
Enter MAC Address (string) to find the manufacturer. MAC Formats Allowed: ('xx-xx-xx-xx-xx-xx', 'xx:xx:xx:xx:xx:xx', 'xxxx.xxxx.xxxx', 'xxxxxxxxxxxx')
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "integer"}]}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
cae89a65-295f-4a30-8298-3ef4dcc6fbca/9fb47ea0-93d4-40fd-8b7a-d26a9ad95c7c/0/0
Mobile Phone Live
An API showing all the latest mobile phones around the world so users can compare with their pricing and specification.
0.1
Get All Mobile Detail with specific market research
This endpoint will return back all the details of mobile marketplaces and newly launched mobile devices.
200
New Example
[{"title": "compare mobile phones", "url": "https://gadgets.ndtv.com/mobiles/compare-best-phoneshttps://gadgets.ndtv.com/mobiles/compare-best-phones", "source": "ndtv"}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"title": {"type": "string"}, "url": {"type": "string"}, "source": {"type": "string"}}, "required": ["source", "title", "url"]}}
045c6ae7-0a6c-4f6f-b8b0-9b70e38631f7/76f6adfd-acda-44d8-a111-7fcb397c0b4f/0/0
User Agent Parser and Generator
Parse and generate user agent strings instantly. With this API, you can easily integrate user agent parsing and generation capabilities into your applications, platforms, or services, enabling you to extract valuable information from user agent strings and create customized user agents for different purposes.
null
Parse User Agent String
Parse User Agent String
200
New Example
{"status": "ok", "error": null, "data": {"ua": "Mozilla/5.0 (Windows NT 6.4) AppleWebKit/537.36.0 (KHTML, like Gecko) Chrome/60.0.0.0 Safari/537.36.0", "browser": {"name": "Chrome", "version": "60.0.0.0", "major": "60"}, "engine": {"name": "Blink", "version": "60.0.0.0"}, "os": {"name": "Windows", "version": "10"}, "device": {}, "cpu": {}}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "error": {"type": "null"}, "data": {"type": "object", "properties": {"ua": {"type": "string"}, "browser": {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "major": {"type": "string"}}, "required": ["major", "name", "version"]}, "engine": {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "string"}}, "required": ["name", "version"]}, "os": {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "string"}}, "required": ["name", "version"]}, "device": {"type": "object"}, "cpu": {"type": "object"}}, "required": ["browser", "cpu", "device", "engine", "os", "ua"]}}, "required": ["data", "error", "status"]}
045c6ae7-0a6c-4f6f-b8b0-9b70e38631f7/90a0e64c-03e9-48ca-b14d-ac5146e21a56/0/0
User Agent Parser and Generator
Parse and generate user agent strings instantly. With this API, you can easily integrate user agent parsing and generation capabilities into your applications, platforms, or services, enabling you to extract valuable information from user agent strings and create customized user agents for different purposes.
null
Generate User Agent
Generate User Agent
200
Success
{"status": "ok", "error": null, "data": {"ua": "Mozilla/5.0 (Windows NT 6.4;) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.0.0 Safari/537.36 Edge/12.0.0.10122", "browser": {"name": "Edge", "version": "12.0.0.10122", "major": "12"}, "engine": {"name": "EdgeHTML", "version": "12.0.0.10122"}, "os": {"name": "Windows", "version": "10"}, "device": {}, "cpu": {}}}
{"type": "object", "properties": {"status": {"type": "string"}, "error": {"type": "null"}, "data": {"type": "object", "properties": {"ua": {"type": "string"}, "browser": {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "major": {"type": "string"}}}, "engine": {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "string"}}}, "os": {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "string"}}}, "device": {"type": "object"}, "cpu": {"type": "object"}}}}}
df97e1c3-3100-44f0-9964-8f13c2be961d/b6962be7-a945-4cb9-8a34-2db5aa54b184/1/0
Helpdesk KPI
The Helpdesk KPI is an API designed to help you manage your customer support operations. This API provides comprehensive Key Performance Indicators (KPIs) that offer deep insights into the efficiency, effectiveness, and customer satisfaction levels of your helpdesk/customer support.
null
Send tickets data
Endpoint for sending tickets data
422
Example_1
{"detail": [{"loc": [], "msg": "", "type": ""}]}
{"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "integer"}]}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
1ccd6f4e-8043-46ad-89a0-f327c0db7199/a59428e1-ff9e-4038-81cd-72f16726cd1d/0/0
Test catch NS req 2
test2
null
rest1
rest1
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
780e5d1b-51dd-4993-a1f0-67023b4b93c9/a132a693-5b74-4ead-86c3-860d3f520c70/0/0
eDocAPI
PDF Generator API | HTML to PDF documents creation and automation
null
/account/identity
Return identity information for current user account
200
null
{"_id": "", "name": "", "firstName": "", "lastName": "", "email": "", "emailVerified": true}
{"type": "object", "additionalProperties": false, "properties": {"_id": {"type": "string"}, "name": {"type": "string"}, "firstName": {"type": "string"}, "lastName": {"type": "string"}, "email": {"type": "string"}, "emailVerified": {"type": "boolean"}}}
780e5d1b-51dd-4993-a1f0-67023b4b93c9/5ca83b78-51de-47ad-a575-08edfd37a97b/0/0
eDocAPI
PDF Generator API | HTML to PDF documents creation and automation
null
/templates
Get templates list
200
null
[{"_id": "", "name": "", "description": "", "thumbnail": "", "official": true, "published": true, "createdAt": "", "tags": []}]
{"type": "array", "maxItems": 20, "items": {"type": "object", "additionalProperties": false, "required": ["_id", "name"], "properties": {"_id": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "thumbnail": {"type": "string"}, "official": {"type": "boolean"}, "published": {"type": "boolean"}, "createdAt": {"type": "string", "format": "date-time"}, "tags": {"type": "array", "items": {"type": "string"}}}}}
780e5d1b-51dd-4993-a1f0-67023b4b93c9/b2845166-d87e-4e5e-8e6c-16172cd27833/0/0
eDocAPI
PDF Generator API | HTML to PDF documents creation and automation
null
/documents/from-template
Generate a PDF document from predefined template
200
null
{"documentUrl": ""}
{"type": "object", "additionalProperties": false, "properties": {"documentUrl": {"type": "string"}}}
780e5d1b-51dd-4993-a1f0-67023b4b93c9/24d752cf-9f5b-4198-ac29-9d01347f7b39/0/0
eDocAPI
PDF Generator API | HTML to PDF documents creation and automation
null
/templates/{id}
Return a single template by id
200
null
{"name": "", "description": "", "official": false, "published": true, "css": "", "html": "", "data": {}, "pdfOptionsMetadata": {}, "screenshotOptionsMetadata": {}, "tags": [], "_id": ""}
{"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "official": {"type": "boolean", "default": false}, "published": {"type": "boolean", "default": true}, "css": {"type": "string"}, "html": {"type": "string"}, "data": {"type": "object", "additionalProperties": true}, "pdfOptionsMetadata": {"type": "object", "required": ["scale"], "additionalProperties": false, "default": {"scale": 1, "displayHeaderFooter": false, "landscape": false, "printBackground": false, "pageRanges": "", "format": "A4", "preferCSSPageSize": false}, "properties": {"scale": {"type": "number", "default": 1, "minimum": 0.1, "maximum": 2}, "displayHeaderFooter": {"type": "boolean", "default": false}, "landscape": {"type": "boolean", "default": false}, "printBackground": {"type": "boolean", "default": false}, "margin": {"type": "object", "additionalProperties": true}, "pageRanges": {"type": "string", "default": ""}, "format": {"type": "string", "default": "A4"}, "width": {"type": "string"}, "height": {"type": "string"}, "preferCSSPageSize": {"type": "boolean", "default": false}, "omitBackground": {"type": "boolean"}}, "allOf": [{"if": {"properties": {"displayHeaderFooter": {"enum": [true]}}}, "then": {"properties": {"headerTemplate": {"type": "string", "default": ""}, "footerTemplate": {"type": "string", "default": ""}}}}]}, "screenshotOptionsMetadata": {"type": "object", "unevaluatedProperties": false, "default": {"screenSize": "md", "type": "png", "fullPage": false, "omitBackground": false, "captureBeyondViewport": false}, "properties": {"screenSize": {"type": "string", "default": "md", "enum": ["xl", "lg", "md", "sm", "xs", "viewport"]}, "viewport": {"type": "object", "required": ["width", "height"], "additionalProperties": false, "properties": {"width": {"type": "number", "minimum": 10, "maximum": 3840}, "height": {"type": "number", "minimum": 10, "maximum": 2160}}}, "type": {"type": "string", "default": "png", "enum": ["png", "jpeg"]}, "fullPage": {"type": "boolean", "default": false}, "omitBackground": {"type": "boolean", "default": false}, "captureBeyondViewport": {"type": "boolean", "default": false}}, "allOf": [{"if": {"properties": {"fullPage": {"const": false}}}, "then": {"properties": {"clip": {"type": "object", "additionalProperties": true, "properties": {"x": {"type": "number", "default": 0}, "y": {"type": "number", "default": 0}, "width": {"type": "number", "default": 1366}, "height": {"type": "number", "default": 768}}}}}}, {"if": {"properties": {"type": {"enum": ["jpeg"]}}}, "then": {"properties": {"quality": {"type": "number", "default": 90, "minimum": 0, "maximum": 100}}}}]}, "tags": {"type": "array", "items": {"type": "string"}}, "_id": {"type": "string"}}, "additionalProperties": false}
780e5d1b-51dd-4993-a1f0-67023b4b93c9/b43b60fc-4c82-4fc4-9230-7ff6de232d80/0/0
eDocAPI
PDF Generator API | HTML to PDF documents creation and automation
null
/templates
Create a new template
200
null
{"insertedId": ""}
{"type": "object", "additionalProperties": false, "properties": {"insertedId": {"type": "string"}}}
780e5d1b-51dd-4993-a1f0-67023b4b93c9/97c0f402-e34f-4165-94be-8708a6dcff69/0/0
eDocAPI
PDF Generator API | HTML to PDF documents creation and automation
null
/documents/from-html
Generate a PDF document from an HTML source code
200
null
{"documentUrl": ""}
{"type": "object", "additionalProperties": false, "properties": {"documentUrl": {"type": "string"}}}
780e5d1b-51dd-4993-a1f0-67023b4b93c9/3ccd080d-f620-468e-a466-ed2069df332d/0/0
eDocAPI
PDF Generator API | HTML to PDF documents creation and automation
null
/documents/from-url
Generate document from webpage URL
200
null
{"documentUrl": ""}
{"type": "object", "additionalProperties": false, "properties": {"documentUrl": {"type": "string"}}}
a21cdb8e-939a-4c58-a20a-6ba033553fd9/07d987a8-4f66-4d90-b4fd-61a1b980e5eb/0/0
Find any IP address or Domain Location world wide
Free IP Geo Location API with 100% accurate geo information of IP address or Domain name like city latitude, longitude, zipcode, state/province, country, country codes, country flag, currency, dialing code. timezone, total number of cities & states/province in country, continent code, continent name and many more details in JSON format. You can also test our API online by this IP lookup tool: https://ipworld.info/iplocator
9.8
IP Location of Client or IP Location of Visitor
Free IP API provides country, city, state, province, local currency, latitude and longitude, company detail, ISP lookup, language, zip code, country calling code, time zone, current time, sunset and sunrise time, moonset and moonrise time from any IPv4 and IPv6 address in REST, JSON and XML format over HTTPS.
200
Response
{"continent": "Asia", "country": "Singapore", "zipCode": "18", "accuracyRadius": 1000, "flag": "https://ipworld.info/static/flags/sg.png", "city": "Singapore", "timezone": "Asia/Singapore", "latitude": 1.3029, "countryGeoNameId": 1880251, "gmt": "(GMT+08:00) Singapore", "network": "3.0.0.0/15", "currencyName": "Singapore Dollar", "countryNativeName": "Singapore", "stateGeoNameId": null, "phoneCode": "+65", "state": null, "continentCode": "AS", "longitude": 103.857, "currencyNamePlural": "Singapore dollars", "cityGeoNameId": 1880252, "languages": "en,ms,ta,zh", "numOfCities": 2, "org": "AMAZON-02", "ip": "3.0.35.31", "currencySymbol": "S$", "currencySymbolNative": "$", "isEU": "No", "countryTLD": ".sg", "countryCapital": "Singapur", "metroCode": null, "continentGeoNameId": 6255147, "stateCode": null, "countryISO2": "SG", "numOfStates": 5, "countryISO3": "SGP", "currencyCode": "SGD", "asNo": 16509, "status": 200}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"continent": {"type": "string"}, "country": {"type": "string"}, "zipCode": {"type": "string"}, "accuracyRadius": {"type": "integer"}, "flag": {"type": "string"}, "city": {"type": "string"}, "timezone": {"type": "string"}, "latitude": {"type": "number"}, "countryGeoNameId": {"type": "integer"}, "gmt": {"type": "string"}, "network": {"type": "string"}, "currencyName": {"type": "string"}, "countryNativeName": {"type": "string"}, "stateGeoNameId": {"type": "null"}, "phoneCode": {"type": "string"}, "state": {"type": "null"}, "continentCode": {"type": "string"}, "longitude": {"type": "number"}, "currencyNamePlural": {"type": "string"}, "cityGeoNameId": {"type": "integer"}, "languages": {"type": "string"}, "numOfCities": {"type": "integer"}, "org": {"type": "string"}, "ip": {"type": "string"}, "currencySymbol": {"type": "string"}, "currencySymbolNative": {"type": "string"}, "isEU": {"type": "string"}, "countryTLD": {"type": "string"}, "countryCapital": {"type": "string"}, "metroCode": {"type": "null"}, "continentGeoNameId": {"type": "integer"}, "stateCode": {"type": "null"}, "countryISO2": {"type": "string"}, "numOfStates": {"type": "integer"}, "countryISO3": {"type": "string"}, "currencyCode": {"type": "string"}, "asNo": {"type": "integer"}, "status": {"type": "integer"}}, "required": ["accuracyRadius", "asNo", "city", "cityGeoNameId", "continent", "continentCode", "continentGeoNameId", "country", "countryCapital", "countryGeoNameId", "countryISO2", "countryISO3", "countryNativeName", "countryTLD", "currencyCode", "currencyName", "currencyNamePlural", "currencySymbol", "currencySymbolNative", "flag", "gmt", "ip", "isEU", "languages", "latitude", "longitude", "metroCode", "network", "numOfCities", "numOfStates", "org", "phoneCode", "state", "stateCode", "stateGeoNameId", "status", "timezone", "zipCode"]}
a21cdb8e-939a-4c58-a20a-6ba033553fd9/5d9dc1be-1e6d-4554-a835-a58bf1165bb8/0/0
Find any IP address or Domain Location world wide
Free IP Geo Location API with 100% accurate geo information of IP address or Domain name like city latitude, longitude, zipcode, state/province, country, country codes, country flag, currency, dialing code. timezone, total number of cities & states/province in country, continent code, continent name and many more details in JSON format. You can also test our API online by this IP lookup tool: https://ipworld.info/iplocator
9.8
IP location by domain name
Free IP Geo Location API which provide 100% accurate complete information of any IP address or Domain name with its city latitude, longitude, zipcode, state/province, country, country codes, country flag, currency, dialing code. timezone, total number of cities & states/province in country, continent code, continent name and many more details in JSON format. You can also test our API online by this IP lookup tool: https://ipworld.info/iplocator
200
Example_1
{"continent": "North America", "country": "United States", "zipCode": "85260", "accuracyRadius": 1000, "flag": "https://ipworld.info/static/flags/us.png", "city": "Scottsdale", "timezone": "America/Phoenix", "latitude": 33.6013, "countryGeoNameId": 6252001, "gmt": "(GMT-10:00) Hawaii Time", "network": "208.109.192.0/18", "currencyName": "US Dollar", "countryNativeName": "United States", "stateGeoNameId": 5551752, "phoneCode": "+1", "state": "Arizona", "continentCode": "NA", "longitude": -111.8867, "currencyNamePlural": "US dollars", "cityGeoNameId": 5313457, "languages": "en", "numOfCities": 19562, "org": "AS-26496-GO-DADDY-COM-LLC", "ip": "208.109.192.70", "currencySymbol": "$", "currencySymbolNative": "$", "isEU": "No", "countryTLD": ".us", "countryCapital": "Washington", "metroCode": 753, "continentGeoNameId": 6255149, "stateCode": "AZ", "countryISO2": "US", "numOfStates": 66, "countryISO3": "USA", "currencyCode": "USD", "asNo": 26496, "status": 200}
{"type": "object", "properties": {"continent": {"type": "string"}, "country": {"type": "string"}, "zipCode": {"type": "string"}, "accuracyRadius": {"type": "integer"}, "flag": {"type": "string"}, "city": {"type": "string"}, "timezone": {"type": "string"}, "latitude": {"type": "number"}, "countryGeoNameId": {"type": "integer"}, "gmt": {"type": "string"}, "network": {"type": "string"}, "currencyName": {"type": "string"}, "countryNativeName": {"type": "string"}, "stateGeoNameId": {"type": "integer"}, "phoneCode": {"type": "string"}, "state": {"type": "string"}, "continentCode": {"type": "string"}, "longitude": {"type": "number"}, "currencyNamePlural": {"type": "string"}, "cityGeoNameId": {"type": "integer"}, "languages": {"type": "string"}, "numOfCities": {"type": "integer"}, "org": {"type": "string"}, "ip": {"type": "string"}, "currencySymbol": {"type": "string"}, "currencySymbolNative": {"type": "string"}, "isEU": {"type": "string"}, "countryTLD": {"type": "string"}, "countryCapital": {"type": "string"}, "metroCode": {"type": "integer"}, "continentGeoNameId": {"type": "integer"}, "stateCode": {"type": "string"}, "countryISO2": {"type": "string"}, "numOfStates": {"type": "integer"}, "countryISO3": {"type": "string"}, "currencyCode": {"type": "string"}, "asNo": {"type": "integer"}, "status": {"type": "integer"}}}
b522c7bc-0f2e-477c-9cec-c48f1539248c/1d067b6b-e7bf-4a83-9bd0-997e98f16e18/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
webhook_log_get
Retrieve the webhook call log records WARNING: Records get deleted after 3 natural months to save space
400
null
{"validation_errors": {"items": ""}}
{"allOf": [{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}, {"description": "A response that shows the user any input validation errors", "properties": {"validation_errors": {"additionalProperties": {"items": {"type": "string"}, "type": "array"}, "description": "Validation errors specific to the input", "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/1d067b6b-e7bf-4a83-9bd0-997e98f16e18/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
webhook_log_get
Retrieve the webhook call log records WARNING: Records get deleted after 3 natural months to save space
500
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/1d067b6b-e7bf-4a83-9bd0-997e98f16e18/2/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
webhook_log_get
Retrieve the webhook call log records WARNING: Records get deleted after 3 natural months to save space
200
null
{"data": {"record_count": 0, "records": [{"created_at": 0, "request": {}, "response": {}, "step_execution": {}}]}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "The record set of webhook calls", "properties": {"data": {"allOf": [{"description": "Base response object containing the record set and record count", "properties": {"record_count": {"description": "The number of records in the given context", "type": "integer"}, "records": {"description": "The record set", "items": {"type": "object"}, "type": "array"}}, "type": "object"}, {"properties": {"records": {"items": {"description": "Information about the webhook request for logging purposes", "properties": {"created_at": {"description": "The timestamp when was this request performed", "type": "integer"}, "request": {"description": "An object containing an http request", "properties": {"body": {"description": "**Omitted**"}, "headers": {"description": "**Omitted**"}, "method": {"description": "**Omitted**"}, "query_params": {"description": "**Omitted**"}, "url": {"description": "**Omitted**"}}, "type": "object"}, "response": {"description": "An object containing an http response", "properties": {"body": {"description": "**Omitted**"}, "headers": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}}, "type": "object"}, "step_execution": {"description": "Contains information about a flow step that already has been executed", "properties": {"created_at": {"description": "**Omitted**"}, "error": {"description": "**Omitted**"}, "exit_code": {"description": "**Omitted**"}, "flow_definition_version": {"description": "**Omitted**"}, "flow_id": {"description": "**Omitted**"}, "flow_name": {"description": "**Omitted**"}, "id": {"description": "**Omitted**"}, "input": {"description": "**Omitted**"}, "output": {"description": "**Omitted**"}, "step_name": {"description": "**Omitted**"}}, "type": "object"}}, "type": "object"}, "type": "array"}}, "type": "object"}]}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/9a7e419f-78cd-4ea1-a732-9e243bb78064/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_id_delete
Delete an existing flow definition
404
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/9a7e419f-78cd-4ea1-a732-9e243bb78064/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_id_delete
Delete an existing flow definition
200
null
{"exit_code": "success", "status": "success"}
{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}
b522c7bc-0f2e-477c-9cec-c48f1539248c/d29e3e32-ebb9-488f-9943-738de281ec60/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_get
Retrieve the flow definition list
400
null
{"validation_errors": {"items": ""}}
{"allOf": [{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}, {"description": "A response that shows the user any input validation errors", "properties": {"validation_errors": {"additionalProperties": {"items": {"type": "string"}, "type": "array"}, "description": "Validation errors specific to the input", "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/d29e3e32-ebb9-488f-9943-738de281ec60/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_get
Retrieve the flow definition list
500
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/d29e3e32-ebb9-488f-9943-738de281ec60/2/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_get
Retrieve the flow definition list
200
null
{"data": {"record_count": 0, "records": [{"created_at": 0, "description": "", "id": "", "status": "active", "updated_at": 0}]}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "The record set of registered flows", "properties": {"data": {"allOf": [{"description": "Base response object containing the record set and record count", "properties": {"record_count": {"description": "The number of records in the given context", "type": "integer"}, "records": {"description": "The record set", "items": {"type": "object"}, "type": "array"}}, "type": "object"}, {"properties": {"records": {"items": {"description": "Overall information of a registered flow", "properties": {"created_at": {"description": "When was this flow created", "type": "integer"}, "description": {"description": "A brief description of what this flow is about", "type": "string"}, "id": {"description": "The flow definition identifier", "type": "string"}, "name": {"description": "The flow name, it must follow the following regexp:\n`^[a-zA-Z_$][a-zA-Z_$0-9]*$`\n"}, "status": {"description": "Indicates wether the flow is turned on or turned off", "enum": ["active", "inactive"], "type": "string"}, "updated_at": {"description": "When was this flow updated", "type": "integer"}}, "type": "object"}, "type": "array"}}, "type": "object"}]}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/1c2d645b-d388-4619-b243-81f5aa4c5217/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_id_get
Retrieve the flow definition detail
404
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/1c2d645b-d388-4619-b243-81f5aa4c5217/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_id_get
Retrieve the flow definition detail
200
null
{"data": {"created_at": 0, "current_version": "", "description": "", "id": "", "status": "active", "steps": {}, "updated_at": 0, "webhook": {"signature_key": "", "url": ""}}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "Successful response after creating or retrieving a flow definition", "properties": {"data": {"description": "Contains the flow definition", "properties": {"created_at": {"description": "When was this flow created", "type": "integer"}, "current_version": {"description": "The version associated with this definition, this is only for traceability purposes, we do not support version rollbacks or anything like that", "type": "string"}, "description": {"description": "A brief description of what this flow is about", "type": "string"}, "id": {"description": "The flow definition identifier", "type": "string"}, "name": {"description": "The flow name, it must follow the following regexp:\n`^[a-zA-Z_$][a-zA-Z_$0-9]*$`\n"}, "status": {"description": "Indicates wether the flow is turned on or turned off", "enum": ["active", "inactive"], "type": "string"}, "steps": {"additionalProperties": {"description": "The step definition", "properties": {"depends_on": {"additionalProperties": {"type": "string"}, "description": "Indicates the required steps along with their respective exit codes that need to be met in order for this step to run. Example:\n```\n# step_b depends on step_a being executed with a success exit code\n# step_c depends on step_b being executed with a success OR noop exit code\n# step_d depends on step_b and step_c being executed with a success exit code\n\nstep_a:\n ...\nstep_b:\n depends_on:\n step_a: success\nstep_c:\n depends_on:\n step_b: success, noop\nstep_d:\n depends_on:\n step_b: success\n step_c: success\n```\n", "type": "object"}, "repeatable": {"default": false, "description": "Boolean flag to indicate that this step can be run multiple times within the same flow", "type": "boolean"}, "triggers": {"additionalProperties": {"items": {"description": "**Omitted**"}, "type": "array"}, "description": "Indicates that after the execution of the step returing a certain exit code it will attempt to execute a following step. Example:\n```\n# After step_a executes with an exit code of success it will attempt to execute step_b\n# A request to execute step_b has been received, since the dependencies have been meet it will execute it\n# If step_b executes with an exit code of success OR noop it will attempt to execute step_c\n\nstep_a:\n triggers:\n success:\n - step_b\nstep_b:\n depends_on:\n step_a: success\n triggers:\n success, noop:\n - step_c\nstep_c:\n```\n", "type": "object"}}, "type": ["object", "null"]}, "description": "Key-Value pair object that contains the steps that will consist on this workflow, the object Key must follow the following regexp: `^[a-zA-Z_$][a-zA-Z_$0-9]*$`\n\nNOTE: If you want to define a step with no additional configuration you can just define the step name with a null value. Example:\n\n```\n\"steps\": {\n \"step_with_no_attributes\": null\n}\n```\n", "type": "object"}, "updated_at": {"description": "When was this flow updated", "type": "integer"}, "webhook": {"description": "Contains information about the target endpoint that will be acting as a webhook", "properties": {"signature_key": {"description": "Key to ensure data authenticity (generated automatically)", "type": "string"}, "url": {"description": "The webhook endpoint, must be https", "type": "string"}}, "type": "object"}}, "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/4e09c98e-a7eb-45c1-8d1f-9dff69f0f785/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_id_put
Updates an existing flow definition, you can just pass the root attributes you wish to update and it wont affect the existing values. NOTE: For updating steps you need to send the whole object with the changes you want to make because that will get overwritten.
404
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/4e09c98e-a7eb-45c1-8d1f-9dff69f0f785/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_id_put
Updates an existing flow definition, you can just pass the root attributes you wish to update and it wont affect the existing values. NOTE: For updating steps you need to send the whole object with the changes you want to make because that will get overwritten.
200
null
{"data": {"created_at": 0, "current_version": "", "description": "", "id": "", "status": "active", "steps": {}, "updated_at": 0, "webhook": {"signature_key": "", "url": ""}}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "Successful response after creating or retrieving a flow definition", "properties": {"data": {"description": "Contains the flow definition", "properties": {"created_at": {"description": "When was this flow created", "type": "integer"}, "current_version": {"description": "The version associated with this definition, this is only for traceability purposes, we do not support version rollbacks or anything like that", "type": "string"}, "description": {"description": "A brief description of what this flow is about", "type": "string"}, "id": {"description": "The flow definition identifier", "type": "string"}, "name": {"description": "The flow name, it must follow the following regexp:\n`^[a-zA-Z_$][a-zA-Z_$0-9]*$`\n"}, "status": {"description": "Indicates wether the flow is turned on or turned off", "enum": ["active", "inactive"], "type": "string"}, "steps": {"additionalProperties": {"description": "The step definition", "properties": {"depends_on": {"additionalProperties": {"type": "string"}, "description": "Indicates the required steps along with their respective exit codes that need to be met in order for this step to run. Example:\n```\n# step_b depends on step_a being executed with a success exit code\n# step_c depends on step_b being executed with a success OR noop exit code\n# step_d depends on step_b and step_c being executed with a success exit code\n\nstep_a:\n ...\nstep_b:\n depends_on:\n step_a: success\nstep_c:\n depends_on:\n step_b: success, noop\nstep_d:\n depends_on:\n step_b: success\n step_c: success\n```\n", "type": "object"}, "repeatable": {"default": false, "description": "Boolean flag to indicate that this step can be run multiple times within the same flow", "type": "boolean"}, "triggers": {"additionalProperties": {"items": {"description": "**Omitted**"}, "type": "array"}, "description": "Indicates that after the execution of the step returing a certain exit code it will attempt to execute a following step. Example:\n```\n# After step_a executes with an exit code of success it will attempt to execute step_b\n# A request to execute step_b has been received, since the dependencies have been meet it will execute it\n# If step_b executes with an exit code of success OR noop it will attempt to execute step_c\n\nstep_a:\n triggers:\n success:\n - step_b\nstep_b:\n depends_on:\n step_a: success\n triggers:\n success, noop:\n - step_c\nstep_c:\n```\n", "type": "object"}}, "type": ["object", "null"]}, "description": "Key-Value pair object that contains the steps that will consist on this workflow, the object Key must follow the following regexp: `^[a-zA-Z_$][a-zA-Z_$0-9]*$`\n\nNOTE: If you want to define a step with no additional configuration you can just define the step name with a null value. Example:\n\n```\n\"steps\": {\n \"step_with_no_attributes\": null\n}\n```\n", "type": "object"}, "updated_at": {"description": "When was this flow updated", "type": "integer"}, "webhook": {"description": "Contains information about the target endpoint that will be acting as a webhook", "properties": {"signature_key": {"description": "Key to ensure data authenticity (generated automatically)", "type": "string"}, "url": {"description": "The webhook endpoint, must be https", "type": "string"}}, "type": "object"}}, "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/3e9ef3fc-f779-492a-89ad-97169388c2f4/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_post
Create a new flow definition
400
null
{"validation_errors": {"items": ""}}
{"allOf": [{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}, {"description": "A response that shows the user any input validation errors", "properties": {"validation_errors": {"additionalProperties": {"items": {"type": "string"}, "type": "array"}, "description": "Validation errors specific to the input", "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/3e9ef3fc-f779-492a-89ad-97169388c2f4/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_post
Create a new flow definition
200
null
{"data": {"created_at": 0, "current_version": "", "description": "", "id": "", "status": "active", "steps": {}, "updated_at": 0, "webhook": {"signature_key": "", "url": ""}}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "Successful response after creating or retrieving a flow definition", "properties": {"data": {"description": "Contains the flow definition", "properties": {"created_at": {"description": "When was this flow created", "type": "integer"}, "current_version": {"description": "The version associated with this definition, this is only for traceability purposes, we do not support version rollbacks or anything like that", "type": "string"}, "description": {"description": "A brief description of what this flow is about", "type": "string"}, "id": {"description": "The flow definition identifier", "type": "string"}, "name": {"description": "The flow name, it must follow the following regexp:\n`^[a-zA-Z_$][a-zA-Z_$0-9]*$`\n"}, "status": {"description": "Indicates wether the flow is turned on or turned off", "enum": ["active", "inactive"], "type": "string"}, "steps": {"additionalProperties": {"description": "The step definition", "properties": {"depends_on": {"additionalProperties": {"type": "string"}, "description": "Indicates the required steps along with their respective exit codes that need to be met in order for this step to run. Example:\n```\n# step_b depends on step_a being executed with a success exit code\n# step_c depends on step_b being executed with a success OR noop exit code\n# step_d depends on step_b and step_c being executed with a success exit code\n\nstep_a:\n ...\nstep_b:\n depends_on:\n step_a: success\nstep_c:\n depends_on:\n step_b: success, noop\nstep_d:\n depends_on:\n step_b: success\n step_c: success\n```\n", "type": "object"}, "repeatable": {"default": false, "description": "Boolean flag to indicate that this step can be run multiple times within the same flow", "type": "boolean"}, "triggers": {"additionalProperties": {"items": {"description": "**Omitted**"}, "type": "array"}, "description": "Indicates that after the execution of the step returing a certain exit code it will attempt to execute a following step. Example:\n```\n# After step_a executes with an exit code of success it will attempt to execute step_b\n# A request to execute step_b has been received, since the dependencies have been meet it will execute it\n# If step_b executes with an exit code of success OR noop it will attempt to execute step_c\n\nstep_a:\n triggers:\n success:\n - step_b\nstep_b:\n depends_on:\n step_a: success\n triggers:\n success, noop:\n - step_c\nstep_c:\n```\n", "type": "object"}}, "type": ["object", "null"]}, "description": "Key-Value pair object that contains the steps that will consist on this workflow, the object Key must follow the following regexp: `^[a-zA-Z_$][a-zA-Z_$0-9]*$`\n\nNOTE: If you want to define a step with no additional configuration you can just define the step name with a null value. Example:\n\n```\n\"steps\": {\n \"step_with_no_attributes\": null\n}\n```\n", "type": "object"}, "updated_at": {"description": "When was this flow updated", "type": "integer"}, "webhook": {"description": "Contains information about the target endpoint that will be acting as a webhook", "properties": {"signature_key": {"description": "Key to ensure data authenticity (generated automatically)", "type": "string"}, "url": {"description": "The webhook endpoint, must be https", "type": "string"}}, "type": "object"}}, "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/3e9ef3fc-f779-492a-89ad-97169388c2f4/2/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_definition_post
Create a new flow definition
500
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/57c41eb3-3629-491c-9baf-7e6498a53069/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_submit_post
Submits a flow execution, this starts the whole flow process by calling the declared steps and performs the desired operations as originally designed
400
null
{"validation_errors": {"items": ""}}
{"allOf": [{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}, {"description": "A response that shows the user any input validation errors", "properties": {"validation_errors": {"additionalProperties": {"items": {"type": "string"}, "type": "array"}, "description": "Validation errors specific to the input", "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/57c41eb3-3629-491c-9baf-7e6498a53069/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_submit_post
Submits a flow execution, this starts the whole flow process by calling the declared steps and performs the desired operations as originally designed
500
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/57c41eb3-3629-491c-9baf-7e6498a53069/2/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_submit_post
Submits a flow execution, this starts the whole flow process by calling the declared steps and performs the desired operations as originally designed
200
null
{"data": {"data": {}, "flow_id": "", "flow_name": "", "step_name": ""}, "exit_code": "success", "status": "success", "request_id": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "The response of the flow submission request", "properties": {"data": {"description": "The information about the flow that will get submitted", "properties": {"data": {"additionalProperties": true, "description": "Any additional data we want to send (size is limited to 1kb)\n\n**WARNING: Avoid passing any sensitive data since its contents get stored**\n", "type": "object"}, "flow_id": {"description": "The flow subject identifier", "type": "string"}, "flow_name": {"description": "The name of the flow we want to run", "type": "string"}, "step_name": {"description": "The name of the flow step we want to run", "type": "string"}}, "required": ["flow_name", "flow_id", "step_name"], "type": "object"}, "request_id": {"description": "The generated request id", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/3cf0b82a-ef93-4941-a902-cb895452ce2a/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_execution_id_flow_id_get
Retrieve the steps executed with this flow WARNING: Records get deleted after 3 natural months to save space
500
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/3cf0b82a-ef93-4941-a902-cb895452ce2a/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_execution_id_flow_id_get
Retrieve the steps executed with this flow WARNING: Records get deleted after 3 natural months to save space
400
null
{"validation_errors": {"items": ""}}
{"allOf": [{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}, {"description": "A response that shows the user any input validation errors", "properties": {"validation_errors": {"additionalProperties": {"items": {"type": "string"}, "type": "array"}, "description": "Validation errors specific to the input", "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/3cf0b82a-ef93-4941-a902-cb895452ce2a/2/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
flow_execution_id_flow_id_get
Retrieve the steps executed with this flow WARNING: Records get deleted after 3 natural months to save space
200
null
{"data": {"record_count": 0, "records": []}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "The record set of executions made in this flow", "properties": {"data": {"allOf": [{"description": "Base response object containing the record set and record count", "properties": {"record_count": {"description": "The number of records in the given context", "type": "integer"}, "records": {"description": "The record set", "items": {"type": "object"}, "type": "array"}}, "type": "object"}, {"properties": {"records": {"items": {"description": "Contains information about a flow step that already has been executed", "properties": {"created_at": {"description": "**Omitted**"}, "error": {"description": "**Omitted**"}, "exit_code": {"description": "**Omitted**"}, "flow_definition_version": {"description": "**Omitted**"}, "flow_id": {"description": "**Omitted**"}, "flow_name": {"description": "**Omitted**"}, "id": {"description": "**Omitted**"}, "input": {"description": "**Omitted**"}, "output": {"description": "**Omitted**"}, "step_name": {"description": "**Omitted**"}}, "type": "object"}, "type": "array"}}, "type": "object"}]}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/e12bc05d-9df0-4af3-84c0-cb77d6bacc31/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_get
Retrieves the dead letter message records WARNING: Records get deleted after 3 natural months to save space
500
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/e12bc05d-9df0-4af3-84c0-cb77d6bacc31/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_get
Retrieves the dead letter message records WARNING: Records get deleted after 3 natural months to save space
400
null
{"validation_errors": {"items": ""}}
{"allOf": [{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}, {"description": "A response that shows the user any input validation errors", "properties": {"validation_errors": {"additionalProperties": {"items": {"type": "string"}, "type": "array"}, "description": "Validation errors specific to the input", "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/e12bc05d-9df0-4af3-84c0-cb77d6bacc31/2/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_get
Retrieves the dead letter message records WARNING: Records get deleted after 3 natural months to save space
200
null
{"data": {"record_count": 0, "records": [{"additional_info": {}, "context": {}, "error": "", "id": ""}]}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "The record set of dead letter records", "properties": {"data": {"allOf": [{"description": "Base response object containing the record set and record count", "properties": {"record_count": {"description": "The number of records in the given context", "type": "integer"}, "records": {"description": "The record set", "items": {"type": "object"}, "type": "array"}}, "type": "object"}, {"properties": {"records": {"items": {"description": "Overall view of a failed step execution that ended up in dead letter", "properties": {"additional_info": {"additionalProperties": true, "description": "Additional information", "type": "object"}, "context": {"description": "Contains information about the context of the step execution", "properties": {"dependencies_context": {"description": "**Omitted**"}, "flow_id": {"description": "**Omitted**"}, "flow_name": {"description": "**Omitted**"}, "request_id": {"description": "**Omitted**"}, "step_name": {"description": "**Omitted**"}, "triggered_by": {"description": "**Omitted**"}}, "type": "object"}, "error": {"description": "Information about the issue that caused this step to end up in dead letter", "type": "string"}, "id": {"description": "The dead letter record identifier", "type": "string"}}, "type": "object"}, "type": "array"}}, "type": "object"}]}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/5520b7a1-3b03-4a69-87d2-ccae4f542456/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_id_post
Re-attempts to run the given step from the dead letter. NOTE: This will count as a submission request
500
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/5520b7a1-3b03-4a69-87d2-ccae4f542456/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_id_post
Re-attempts to run the given step from the dead letter. NOTE: This will count as a submission request
404
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/5520b7a1-3b03-4a69-87d2-ccae4f542456/2/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_id_post
Re-attempts to run the given step from the dead letter. NOTE: This will count as a submission request
200
null
{"data": {"additional_info": {}, "context": {}, "error": "", "id": ""}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "The record set of registered flows", "properties": {"data": {"description": "Overall view of a failed step execution that ended up in dead letter", "properties": {"additional_info": {"additionalProperties": true, "description": "Additional information", "type": "object"}, "context": {"description": "Contains information about the context of the step execution", "properties": {"dependencies_context": {"description": "**Omitted**"}, "flow_id": {"description": "**Omitted**"}, "flow_name": {"description": "**Omitted**"}, "request_id": {"description": "**Omitted**"}, "step_name": {"description": "**Omitted**"}, "triggered_by": {"description": "**Omitted**"}}, "type": "object"}, "error": {"description": "Information about the issue that caused this step to end up in dead letter", "type": "string"}, "id": {"description": "The dead letter record identifier", "type": "string"}}, "type": "object"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/b9286b77-c8c4-4467-95de-ecdffaf56bed/0/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_id_delete
Delete the given dead letter record
404
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/b9286b77-c8c4-4467-95de-ecdffaf56bed/1/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_id_delete
Delete the given dead letter record
500
null
{"exit_code": "success", "status": "success", "error": ""}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "A response that shows the user that an error has occurred", "properties": {"error": {"description": "Message describing the error", "type": "string"}}, "type": "object"}]}
b522c7bc-0f2e-477c-9cec-c48f1539248c/b9286b77-c8c4-4467-95de-ecdffaf56bed/2/0
Business Workflow Runner
Step-Based asynchronous business workflow API, for asynchronous processing and event-driven architectures
7.2
dead_letter_id_delete
Delete the given dead letter record
200
null
{"data": {"additional_info": {}, "context": {}, "error": "", "id": ""}, "exit_code": "success", "status": "success"}
{"allOf": [{"description": "A simple response representation", "properties": {"data": {"description": "Schema that represents any serializable data", "oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}, {"description": "**Omitted**"}]}, "exit_code": {"description": "The response exit code returned from the server, it can be:\n* success: The request worked as expected\n* validation_error: The request contains an user input related error\n* unauthorized: Invalid credentials\n* generic_error: The request contains a generic error\n* service_down: The backend server is down\n* flow_disabled: The requested flow is currently marked as disabled\n* service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan\n* service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan\n", "enum": ["success", "validation_error", "unauthorized", "generic_error", "service_unavailable", "resource_not_found", "step_already_executed", "flow_disabled", "service_plan_max_registered_flows_reached", "service_plan_max_steps_per_flow_reached"], "type": "string"}, "status": {"description": "The response status returned from the server, it can be:\n* success: The request worked as expected\n* error: The request returned an error\n", "enum": ["success", "error"], "type": "string"}}, "type": "object"}, {"description": "The record set of registered flows", "properties": {"data": {"description": "Overall view of a failed step execution that ended up in dead letter", "properties": {"additional_info": {"additionalProperties": true, "description": "Additional information", "type": "object"}, "context": {"description": "Contains information about the context of the step execution", "properties": {"dependencies_context": {"description": "**Omitted**"}, "flow_id": {"description": "**Omitted**"}, "flow_name": {"description": "**Omitted**"}, "request_id": {"description": "**Omitted**"}, "step_name": {"description": "**Omitted**"}, "triggered_by": {"description": "**Omitted**"}}, "type": "object"}, "error": {"description": "Information about the issue that caused this step to end up in dead letter", "type": "string"}, "id": {"description": "The dead letter record identifier", "type": "string"}}, "type": "object"}}, "type": "object"}]}
4406613a-2155-4971-8d7e-67db78bdec8e/4ddd1f7a-5d60-40b3-a928-b4974535367a/0/0
Codester API
With this API, you can get information about items such as prices, get a specific seller's items and so on
5
Items
You can get item details such as description, price, author, images and so on.
200
Item example response
{"title": "Price comparison Python script for resellers", "short-desc": " Price comparison Python script for resellersPrice comparison Python script for resellers Compare the seller's or manufacturer's prices with yours every day! ", "image": "https://codester.com/cdn-cgi/mirage/e1e0c461c5ce3f91e13b78faee24479c7ceac073ed8c13ab09aa04de71a9c807/1440/https://www.codester.com/static/uploads/items/000/040/40946/icon.png", "description": " As a reseller, do you always waste a lot of time by constantly checking other webshops for price changes? Is it a bad feeling that the other company can change the price of the product at any moment and thus your business will be unprofitable? This simple Python script will help you with that! It automatically compares the products listed in the .csv file and sends you an email about the changes! In addition to these, it is also able to check the warehouse status of products.", "features": null}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"title": {"type": "string"}, "short-desc": {"type": "string"}, "image": {"type": "string"}, "description": {"type": "string"}, "features": {"type": "null"}}, "required": ["description", "features", "image", "short-desc", "title"]}
18da8a4a-7705-482e-bf44-d3bb41ac6071/2045c90e-17ed-43bd-b202-d6f9a557b662/0/0
URLO
FREE URL SHORTENER
0
/api/branded-short-url
/api/branded-short-url
200
Example_1
{"errors": {"errorCode": "00", "errorMessage": "Success."}, "data": {"title": null, "shortUrl": "natureinfotech.com/a5eba935", "originalUrl": "https://natureinfotech.com/contact-us/", "totalClicks": 1, "createdAt": "05-02-2022 11:56:13", "updatedAt": "10-08-2022 10:37:22"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"errors": {"type": "object", "properties": {"errorCode": {"type": "string"}, "errorMessage": {"type": "string"}}, "required": ["errorCode", "errorMessage"]}, "data": {"type": "object", "properties": {"title": {"type": "null"}, "shortUrl": {"type": "string"}, "originalUrl": {"type": "string"}, "totalClicks": {"type": "integer"}, "createdAt": {"type": "string"}, "updatedAt": {"type": "string"}}, "required": ["createdAt", "originalUrl", "shortUrl", "title", "totalClicks", "updatedAt"]}}, "required": ["data", "errors"]}
b4b0e84c-92be-465c-bc33-1663d8d6c9f3/a2de66be-e11e-40bf-ab7b-797501b0f863/0/0
tev
tev
null
/sample_endpoint
Retrieve information from the API
200
null
{"message": "Hello, world!"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}}, "required": ["message"]}
984e1681-43a4-47ba-9a52-77f2c3ee6648/14867f74-ce33-4a14-9880-67f0a2f4709a/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Remove a participant
Delete a participant from a tournament
200
Response
{"participantIndex": 0, "message": "Participant with id 62fc4ae56010f469060d45a6 was deleted successfully", "participants": []}
{"type": "object", "properties": {"participantIndex": {"type": "integer"}, "message": {"type": "string"}, "participants": {"type": "array"}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/cb9eb165-532a-4677-a86c-6cbbc74cd35b/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Create new tournament
Create new tournament
200
Response
{"success": true, "newTournament": {"name": "Championship", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Round Robin", "numberofparticipants": 4, "fixturesdaterange": [1660836149412, 1661700149412], "fixturesExpirationDelay": 3600000, "forfeitScore": {"winner": 5, "loser": 0}, "checkInTimeout": 900000, "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"], "numOfMatches": 2, "_id": "62fe4b57e154f49650da065f", "participants": [], "conferences": [], "fixtures": [{"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-18T15:22:29.412Z", "scheduledtime": 1660836149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0660"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-19T09:09:09.412Z", "scheduledtime": 1660900149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0661"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-20T02:55:49.412Z", "scheduledtime": 1660964149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0662"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-20T20:42:29.412Z", "scheduledtime": 1661028149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0663"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-21T14:29:09.412Z", "scheduledtime": 1661092149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0664"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-22T08:15:49.412Z", "scheduledtime": 1661156149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0665"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-23T02:02:29.412Z", "scheduledtime": 1661220149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0666"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-23T19:49:09.412Z", "scheduledtime": 1661284149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0667"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-24T13:35:49.412Z", "scheduledtime": 1661348149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0668"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-25T07:22:29.412Z", "scheduledtime": 1661412149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da0669"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-26T01:09:09.412Z", "scheduledtime": 1661476149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da066a"}, {"tournamentid": "62fe4b57e154f49650da065f", "participant1": null, "participant2": null, "scheduleddate": "2022-08-26T18:55:49.412Z", "scheduledtime": 1661540149412, "rescheduleHistory": [], "_id": "62fe4b57e154f49650da066b"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "yzrkkw01", "hostingChannel": null, "webhookConfig": {"webhook_url": "https://example.com", "webhook_secret": "secretvalue", "webhook_events": ["onTournamentCreated", "onParticipantAdded", "onNextRound", "onMatchFinished", "onParticipantCheckedIn", "onParticipantCheckedOut", "onMinParticipantsCheckedIn", "onAllParticipantsCheckedIn", "onSeriesFinished", "onParticipantFull", "onTournamentFinished", "onParticipantDeleted", "onTournamentDeleted", "onFixtureRescheduled", "onTournamentStarted"]}, "createdAt": "2022-08-18T14:23:19.906Z", "updatedAt": "2022-08-18T14:23:20.034Z", "__v": 0, "parameters": {"name": "Championship", "tournamentformat": "Round Robin", "numberofparticipants": 4, "forfeitScore": {"winner": 5, "loser": 0}, "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "numOfMatches": 2, "fixturesdaterange": [1660836149412, 1661700149412], "webhook_url": "https://example.com", "webhook_secret": "secretvalue", "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"]}}}
{"type": "object", "properties": {"success": {"type": "boolean"}, "newTournament": {"type": "object", "properties": {"name": {"type": "string"}, "discordGuildRoles": {"type": "array"}, "dependencies": {"type": "array"}, "tournamentformat": {"type": "string"}, "numberofparticipants": {"type": "integer"}, "fixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "fixturesExpirationDelay": {"type": "integer"}, "forfeitScore": {"type": "object", "properties": {"winner": {"type": "integer"}, "loser": {"type": "integer"}}}, "checkInTimeout": {"type": "integer"}, "indexes": {"type": "array", "items": {"type": "string"}}, "indexesRules": {"type": "array", "items": {"type": "string"}}, "numOfMatches": {"type": "integer"}, "_id": {"type": "string"}, "participants": {"type": "array"}, "conferences": {"type": "array"}, "fixtures": {"type": "array", "items": {"type": "object", "properties": {"tournamentid": {"type": "string"}, "participant1": {"type": "null"}, "participant2": {"type": "null"}, "scheduleddate": {"type": "string"}, "scheduledtime": {"type": "integer"}, "rescheduleHistory": {"type": "array"}, "_id": {"type": "string"}}}}, "app": {"type": "string"}, "manager": {"type": "string"}, "privacy": {"type": "string"}, "imageIllustrationUrl": {"type": "string"}, "matchmakingKey": {"type": "string"}, "hostingChannel": {"type": "null"}, "webhookConfig": {"type": "object", "properties": {"webhook_url": {"type": "string"}, "webhook_secret": {"type": "string"}, "webhook_events": {"type": "array", "items": {"type": "string"}}}}, "createdAt": {"type": "string"}, "updatedAt": {"type": "string"}, "__v": {"type": "integer"}, "parameters": {"type": "object", "properties": {"name": {"type": "string"}, "tournamentformat": {"type": "string"}, "numberofparticipants": {"type": "integer"}, "forfeitScore": {"type": "object", "properties": {"winner": {"type": "integer"}, "loser": {"type": "integer"}}}, "fixturesExpirationDelay": {"type": "integer"}, "checkInTimeout": {"type": "integer"}, "numOfMatches": {"type": "integer"}, "fixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "webhook_url": {"type": "string"}, "webhook_secret": {"type": "string"}, "indexes": {"type": "array", "items": {"type": "string"}}, "indexesRules": {"type": "array", "items": {"type": "string"}}}}}}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/4c5abfea-f764-4eaf-a2c0-f6d94f46933c/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Retrieve leaderboard
Retrieve the tournament leaderboard
200
Response
{"message": "Here is the ranking for this tournament", "rankings": {"fixture_1": {"62fbe872ed92d61a14ca6901": [{"participantId": "62fbead0e74cf7f71ad82e60", "name": "Bayern FC", "indexes": {"Points": 0}}, {"participantId": "62fbe8f1ed92d61a14ca691f", "name": "Stock FC", "indexes": {"Points": 0}}, {"participantId": "62fbe8c4ed92d61a14ca6919", "name": "United FC", "indexes": {"Points": 0}}]}, "fixture_2": {"62fbe872ed92d61a14ca6902": [{"participantId": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC", "indexes": {"Points": 3}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:04:58.470Z"}, {"participantId": "62fbe8b2ed92d61a14ca6913", "name": "City FC", "indexes": {"Points": 1}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:05:28.046Z"}, {"participantId": "62fbeaafe74cf7f71ad82e59", "name": "Paris FC", "indexes": {"Points": 0}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:06:07.500Z"}]}, "fixture_3": {"62fbe872ed92d61a14ca6903": [{"participantId": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC", "indexes": {"Points": 0}}]}}}
{"type": "object", "properties": {"message": {"type": "string"}, "rankings": {"type": "object", "properties": {"fixture_1": {"type": "object", "properties": {"62fbe872ed92d61a14ca6901": {"type": "array", "items": {"type": "object", "properties": {"participantId": {"type": "string"}, "name": {"type": "string"}, "indexes": {"type": "object", "properties": {"Points": {"type": "integer"}}}}}}}}, "fixture_2": {"type": "object", "properties": {"62fbe872ed92d61a14ca6902": {"type": "array", "items": {"type": "object", "properties": {"participantId": {"type": "string"}, "name": {"type": "string"}, "indexes": {"type": "object", "properties": {"Points": {"type": "integer"}}}, "areIndexesModified": {"type": "boolean"}, "checkInTime": {"type": "string"}}}}}}, "fixture_3": {"type": "object", "properties": {"62fbe872ed92d61a14ca6903": {"type": "array", "items": {"type": "object", "properties": {"participantId": {"type": "string"}, "name": {"type": "string"}, "indexes": {"type": "object", "properties": {"Points": {"type": "integer"}}}}}}}}}}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/9d29f2e9-3bf3-452e-a7c4-42a0e6aadaf4/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Retrieve multiple tournaments
Retrieve all your tournaments
200
Response
{"tournaments": [{"forfeitScore": {"winner": 5, "loser": 0}, "_id": "62fc3cba2efe0a89b6586e05", "name": "My new tournament", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Round Robin", "numberofparticipants": 4, "fixturesdaterange": [1660701367862, 1661565367862], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"], "numOfMatches": 2, "participants": [], "conferences": [], "fixtures": [{"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-17T01:56:07.862Z", "scheduledtime": 1660701367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e06"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-17T19:42:47.862Z", "scheduledtime": 1660765367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e07"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-18T13:29:27.862Z", "scheduledtime": 1660829367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e08"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-19T07:16:07.862Z", "scheduledtime": 1660893367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e09"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-20T01:02:47.862Z", "scheduledtime": 1660957367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0a"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-20T18:49:27.862Z", "scheduledtime": 1661021367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0b"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-21T12:36:07.862Z", "scheduledtime": 1661085367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0c"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-22T06:22:47.862Z", "scheduledtime": 1661149367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0d"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-23T00:09:27.862Z", "scheduledtime": 1661213367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0e"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-23T17:56:07.862Z", "scheduledtime": 1661277367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0f"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-24T11:42:47.862Z", "scheduledtime": 1661341367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e10"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-25T05:29:27.862Z", "scheduledtime": 1661405367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e11"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "8q3e76po", "hostingChannel": null, "createdAt": "2022-08-17T00:56:26.660Z", "updatedAt": "2022-08-17T00:56:26.684Z", "__v": 0, "parameters": {"name": "My new tournament", "tournamentformat": "Round Robin", "numberofparticipants": 4, "forfeitScore": {"winner": 5, "loser": 0}, "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "numOfMatches": 2, "fixturesdaterange": [1660701367862, 1661565367862], "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"]}}, {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fc0c2280738ded81599b73", "name": "National League", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "League", "conferences": [{"name": "Western Conference", "divisions": [{"name": "Pacific"}, {"name": "Northwest"}], "numberofparticipants": 4, "_id": "62fc0c2280738ded81599b74"}, {"name": "Eastern Conference", "divisions": [{"name": "Atlantic"}, {"name": "Central"}], "numberofparticipants": 4, "_id": "62fc0c2280738ded81599b75"}], "fixturesdaterange": [1660688916353, 1661552916353], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points"], "indexesRules": ["+Points"], "qualifyNumPerConference": 2, "playoffWinsNeeded": 2, "participants": [{"name": "Liverpool FC", "conference": "Western Conference", "division": "Pacific", "discordId": 12345, "stats": {"Points": 0}, "_id": "62fc0cb080738ded81599b7c"}, {"name": "Montreal Canadiens", "conference": "Eastern Conference", "division": "Atlantic", "stats": {"Points": 0}, "_id": "62fc0df79d6b02eb4659ca78"}], "fixtures": [], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "umdggcqi", "hostingChannel": null, "playoffFixturesdaterange": [1661642916353, 1662506916353], "sortByWinRate": false, "createdAt": "2022-08-16T21:29:06.603Z", "updatedAt": "2022-08-16T21:36:55.254Z", "__v": 2, "parameters": {"name": "National League", "tournamentformat": "League", "conferences": [{"name": "Western Conference", "numberofparticipants": 4, "divisions": [{"name": "Pacific"}, {"name": "Northwest"}]}, {"name": "Eastern Conference", "numberofparticipants": 4, "divisions": [{"name": "Atlantic"}, {"name": "Central"}]}], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "discordGuildId": "12345", "indexes": ["Points"], "indexesRules": ["+Points"], "fixturesdaterange": [1660688916353, 1661552916353], "sameConferenceMatchesNum": 2, "qualifyNumPerConference": 2, "playoffWinsNeeded": 2, "againstConferenceMatchesNum": 1, "sameDivisionMatchesNum": 4, "playoffFixturesdaterange": [1661642916353, 1662506916353]}}, {"group_stage": {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fc0b4880738ded81599b62", "name": "My brand new tournament", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Two Stages", "matchesInGroup": 2, "qualifyingParticipantsPerGroup": 2, "wildCard": 8, "fixturesdaterange": [1660688707914, 1661552707914], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Goals"], "indexesRules": ["+Goals"], "numOfMatches": 1, "twoRoundsFinals": false, "thirdPlaceRequired": false, "participants": [{"name": "Liverpool FC", "discordId": 12345, "group": "C", "stats": {"Goals": 0}, "_id": "62fc0bd780738ded81599b6c"}], "conferences": [], "fixtures": [], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "h7orneg6", "hostingChannel": null, "knockoutdaterange": [1661642707914, 1662506707914], "minGroupSize": 3, "maxGroupSize": 4, "groupScore": {"win": 3, "draw": 1, "loss": 0}, "groups": ["A", "B", "C"], "stage": 1, "createdAt": "2022-08-16T21:25:28.118Z", "updatedAt": "2022-08-16T21:27:51.948Z", "__v": 1, "knockoutTournamentId": "62fc0b4a0426b932ef9dd3cc", "parameters": {"name": "My brand new tournament", "tournamentformat": "Two Stages", "groupsNum": 3, "numOfMatches": 1, "qualifyingParticipantsPerGroup": 2, "wildCard": 8, "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "fixturesdaterange": [1660688707914, 1661552707914], "thirdPlaceRequired": false, "matchesInGroup": 2, "twoRoundsFinals": false, "discordGuildId": "12345", "indexes": ["Goals"], "indexesRules": ["+Goals"], "knockoutdaterange": [1661642707914, 1662506707914], "stage": 1, "matchmakingKey": "h7orneg6", "privacy": "public"}}, "knockout_stage": {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fc0b4a0426b932ef9dd3cc", "name": "My brand new tournament", "discordGuildId": "12345", "discordGuildRoles": [], "privacy": "public", "matchmakingKey": "h7orneg6", "dependencies": [], "stage": 2, "groupStageTournamentId": "62fc0b4880738ded81599b62", "tournamentformat": "Knockout", "matchesInGroup": 2, "qualifyingParticipantsPerGroup": 2, "wildCard": 8, "numberofparticipants": 8, "fixturesdaterange": [1661642707914, 1662506707914], "knockoutdaterange": [1661642707914, 1662506707914], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Goals"], "indexesRules": ["+Goals"], "numOfMatches": 1, "twoRoundsFinals": false, "thirdPlaceRequired": false, "participants": [], "conferences": [], "fixtures": [{"tournamentid": "62fc0b4a0426b932ef9dd3cc", "participant1": null, "participant2": null, "scheduleddate": "2022-08-27T23:25:07.914Z", "scheduledtime": 1661642707914, "round": 1, "rescheduleHistory": [], "_id": "62fc0b4a0426b932ef9dd3cd"}, {"tournamentid": "62fc0b4a0426b932ef9dd3cc", "participant1": null, "participant2": null, "scheduleddate": "2022-08-29T09:42:16.485Z", "scheduledtime": 1661766136485, "round": 1, "rescheduleHistory": [], "_id": "62fc0b4a0426b932ef9dd3ce"}, {"tournamentid": "62fc0b4a0426b932ef9dd3cc", "participant1": null, "participant2": null, "scheduleddate": "2022-08-30T19:59:25.056Z", "scheduledtime": 1661889565056, "round": 1, "rescheduleHistory": [], "_id": "62fc0b4a0426b932ef9dd3cf"}, {"tournamentid": "62fc0b4a0426b932ef9dd3cc", "participant1": null, "participant2": null, "scheduleddate": "2022-09-01T06:16:33.628Z", "scheduledtime": 1662012993628, "round": 1, "rescheduleHistory": [], "_id": "62fc0b4a0426b932ef9dd3d0"}, {"tournamentid": "62fc0b4a0426b932ef9dd3cc", "participant1": null, "participant2": null, "scheduleddate": "2022-09-02T16:33:42.199Z", "scheduledtime": 1662136422199, "round": 2, "rescheduleHistory": [], "_id": "62fc0b4a0426b932ef9dd3d1"}, {"tournamentid": "62fc0b4a0426b932ef9dd3cc", "participant1": null, "participant2": null, "scheduleddate": "2022-09-04T02:50:50.771Z", "scheduledtime": 1662259850771, "round": 2, "rescheduleHistory": [], "_id": "62fc0b4a0426b932ef9dd3d2"}, {"tournamentid": "62fc0b4a0426b932ef9dd3cc", "participant1": null, "participant2": null, "scheduleddate": "2022-09-05T13:07:59.342Z", "scheduledtime": 1662383279342, "round": 3, "rescheduleHistory": [], "_id": "62fc0b4a0426b932ef9dd3d3"}], "app": "jackmatrix75", "manager": "jackmatrix75", "imageIllustrationUrl": "", "hostingChannel": null, "createdAt": "2022-08-16T21:25:30.630Z", "updatedAt": "2022-08-16T21:25:30.813Z", "__v": 0, "parameters": {"name": "My brand new tournament", "tournamentformat": "Knockout", "groupsNum": 3, "numOfMatches": 1, "qualifyingParticipantsPerGroup": 2, "wildCard": 8, "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "fixturesdaterange": [1661642707914, 1662506707914], "thirdPlaceRequired": false, "matchesInGroup": 2, "twoRoundsFinals": false, "discordGuildId": "12345", "indexes": ["Goals"], "indexesRules": ["+Goals"], "knockoutdaterange": [1661642707914, 1662506707914], "numberofparticipants": 8, "stage": 2, "matchmakingKey": "h7orneg6", "privacy": "public"}}}, {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fbe872ed92d61a14ca6900", "name": "Battle Royal Tournament", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Free For All", "minGroupSize": 3, "maxGroupSize": 4, "fixturesdaterange": [1660679800258, 1661543800258], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points"], "indexesRules": ["+Points"], "participants": [{"name": "Liverpool FC", "discordId": 12345, "group": "B", "stats": {"Points": 0}, "_id": "62fbe896ed92d61a14ca690d"}, {"name": "City FC", "discordId": 12345, "group": "B", "stats": {"Points": 0}, "_id": "62fbe8b2ed92d61a14ca6913"}, {"name": "United FC", "discordId": 12345, "group": "A", "stats": {"Points": 0}, "_id": "62fbe8c4ed92d61a14ca6919"}, {"name": "Stock FC", "discordId": 12345, "group": "A", "stats": {"Points": 0}, "_id": "62fbe8f1ed92d61a14ca691f"}, {"name": "Paris FC", "discordId": 12345, "group": "B", "stats": {"Points": 0}, "_id": "62fbeaafe74cf7f71ad82e59"}, {"name": "Bayern FC", "discordId": 12345, "group": "A", "stats": {"Points": 0}, "_id": "62fbead0e74cf7f71ad82e60"}], "conferences": [], "fixtures": [{"participants": [{"participantId": "62fbe8c4ed92d61a14ca6919", "name": "United FC", "indexes": {"Points": 0}}, {"participantId": "62fbe8f1ed92d61a14ca691f", "name": "Stock FC", "indexes": {"Points": 0}}, {"participantId": "62fbead0e74cf7f71ad82e60", "name": "Bayern FC", "indexes": {"Points": 0}}], "scheduleddate": "2022-08-16T19:56:40.258Z", "scheduledtime": 1660679800258, "round": 1, "index": 1, "fixtureLabel": "A", "rescheduleHistory": [], "_id": "62fbe872ed92d61a14ca6901"}, {"participants": [{"participantId": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC", "indexes": {"Points": 3}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:04:58.470Z"}, {"participantId": "62fbe8b2ed92d61a14ca6913", "name": "City FC", "indexes": {"Points": 1}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:05:28.046Z"}, {"participantId": "62fbeaafe74cf7f71ad82e59", "name": "Paris FC", "indexes": {"Points": 0}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:06:07.500Z"}], "qualifyingparticipants": ["Liverpool FC"], "scheduleddate": "2022-08-20T03:56:40.258Z", "scheduledtime": 1660967800258, "round": 1, "index": 2, "fixtureLabel": "B", "modified": true, "rescheduleHistory": [], "_id": "62fbe872ed92d61a14ca6902"}, {"participants": [{"participantId": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC", "indexes": {"Points": 0}}], "scheduleddate": "2022-08-20T06:44:14.258Z", "scheduledtime": 1660977854258, "round": 2, "index": 3, "rescheduleHistory": ["1660977854258"], "_id": "62fbe872ed92d61a14ca6903"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "ne5r3mgc", "hostingChannel": null, "qualifyingPerFixture": 1, "createdAt": "2022-08-16T18:56:50.668Z", "updatedAt": "2022-08-17T00:40:54.196Z", "__v": 14, "parameters": {"name": "Battle Royal Tournament", "tournamentformat": "Free For All", "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "discordGuildId": "12345", "indexes": ["Points"], "indexesRules": ["+Points"], "fixturesdaterange": [1660679800258, 1661543800258], "groupsNum": 2, "minGroupSize": 3, "maxGroupSize": 4, "qualifiedPerMatch": 1}, "status": "started"}, {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fbe50393fc76b9854cf34e", "name": "Battle Royal Tournament", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Free For All", "minGroupSize": 2, "maxGroupSize": 2, "fixturesdaterange": [1660678645445, 1661542645445], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points"], "indexesRules": ["+Points"], "participants": [{"name": "Liverpool FC", "discordId": 12345, "group": "B", "stats": {"Points": 0}, "_id": "62fbe7caed92d61a14ca68dc"}, {"name": "United FC", "discordId": 12345, "group": "B", "stats": {"Points": 0}, "_id": "62fbe7f0ed92d61a14ca68e7"}, {"name": "City FC", "discordId": 12345, "group": "A", "stats": {"Points": 0}, "_id": "62fbe81ced92d61a14ca68f2"}, {"name": "Arsenal FC", "discordId": 12345, "group": "A", "stats": {"Points": 0}, "_id": "62fbe840ed92d61a14ca68f8"}], "conferences": [], "fixtures": [{"participants": [{"participantId": "62fbe81ced92d61a14ca68f2", "name": "City FC", "indexes": {"Points": 0}}, {"participantId": "62fbe840ed92d61a14ca68f8", "name": "Arsenal FC", "indexes": {"Points": 0}}], "scheduleddate": "2022-08-16T19:37:25.445Z", "scheduledtime": 1660678645445, "round": 1, "index": 1, "fixtureLabel": "A", "rescheduleHistory": [], "_id": "62fbe50393fc76b9854cf34f"}, {"participants": [{"participantId": "62fbe7caed92d61a14ca68dc", "name": "Liverpool FC", "indexes": {"Points": 0}, "checkInTime": "2022-08-16T22:07:10.360Z"}, {"participantId": "62fbe7f0ed92d61a14ca68e7", "name": "United FC", "indexes": {"Points": 0}}], "scheduleddate": "2022-08-20T03:37:25.445Z", "scheduledtime": 1660966645445, "round": 1, "index": 2, "fixtureLabel": "B", "rescheduleHistory": [], "_id": "62fbe50393fc76b9854cf350"}, {"participants": [], "scheduleddate": "2022-08-23T11:37:25.445Z", "scheduledtime": 1661254645445, "round": 2, "index": 3, "rescheduleHistory": [], "_id": "62fbe50393fc76b9854cf351"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "ptyqntxr", "hostingChannel": null, "qualifyingPerFixture": 1, "createdAt": "2022-08-16T18:42:11.777Z", "updatedAt": "2022-08-16T22:07:10.423Z", "__v": 20, "parameters": {"name": "Battle Royal Tournament", "tournamentformat": "Free For All", "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "discordGuildId": "12345", "indexes": ["Points"], "indexesRules": ["+Points"], "fixturesdaterange": [1660678645445, 1661542645445], "groupsNum": 2, "minGroupSize": 2, "maxGroupSize": 2, "qualifiedPerMatch": 1}, "status": "started"}, {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fbe4c893fc76b9854cf347", "name": "Battle Royal Tournament", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Free For All", "minGroupSize": 2, "maxGroupSize": 2, "fixturesdaterange": [1660678645445, 1661542645445], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points"], "indexesRules": ["+Points"], "participants": [], "conferences": [], "fixtures": [{"participants": [], "scheduleddate": "2022-08-16T19:37:25.445Z", "scheduledtime": 1660678645445, "round": 1, "index": 1, "fixtureLabel": "A", "rescheduleHistory": [], "_id": "62fbe4c893fc76b9854cf348"}, {"participants": [], "scheduleddate": "2022-08-20T03:37:25.445Z", "scheduledtime": 1660966645445, "round": 1, "index": 2, "fixtureLabel": "B", "rescheduleHistory": [], "_id": "62fbe4c893fc76b9854cf349"}, {"participants": [], "scheduleddate": "2022-08-23T11:37:25.445Z", "scheduledtime": 1661254645445, "round": 2, "index": 3, "rescheduleHistory": [], "_id": "62fbe4c893fc76b9854cf34a"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "rkc3my7s", "hostingChannel": null, "qualifyingPerFixture": 1, "createdAt": "2022-08-16T18:41:12.513Z", "updatedAt": "2022-08-16T18:41:12.521Z", "__v": 0, "parameters": {"name": "Battle Royal Tournament", "tournamentformat": "Free For All", "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "discordGuildId": "12345", "indexes": ["Points"], "indexesRules": ["+Points"], "fixturesdaterange": [1660678645445, 1661542645445], "groupsNum": 2, "minGroupSize": 2, "maxGroupSize": 2, "qualifiedPerMatch": 1}}, {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fbe41893fc76b9854cf340", "name": "Battle Royal Tournament", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Free For All", "minGroupSize": 3, "maxGroupSize": 4, "fixturesdaterange": [1660678645445, 1661542645445], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points"], "indexesRules": ["+Points"], "participants": [], "conferences": [], "fixtures": [{"participants": [], "scheduleddate": "2022-08-16T19:37:25.445Z", "scheduledtime": 1660678645445, "round": 1, "index": 1, "fixtureLabel": "A", "rescheduleHistory": [], "_id": "62fbe41893fc76b9854cf341"}, {"participants": [], "scheduleddate": "2022-08-20T03:37:25.445Z", "scheduledtime": 1660966645445, "round": 1, "index": 2, "fixtureLabel": "B", "rescheduleHistory": [], "_id": "62fbe41893fc76b9854cf342"}, {"participants": [], "scheduleddate": "2022-08-23T11:37:25.445Z", "scheduledtime": 1661254645445, "round": 2, "index": 3, "rescheduleHistory": [], "_id": "62fbe41893fc76b9854cf343"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "5exbipno", "hostingChannel": null, "qualifyingPerFixture": 2, "createdAt": "2022-08-16T18:38:16.878Z", "updatedAt": "2022-08-16T18:38:16.888Z", "__v": 0, "parameters": {"name": "Battle Royal Tournament", "tournamentformat": "Free For All", "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "discordGuildId": "12345", "indexes": ["Points"], "indexesRules": ["+Points"], "fixturesdaterange": [1660678645445, 1661542645445], "groupsNum": 2, "minGroupSize": 3, "maxGroupSize": 4, "qualifiedPerMatch": 2}}, {"forfeitScore": {"winner": 5, "loser": 0}, "_id": "62fbe3f193fc76b9854cf330", "name": "Championship", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Round Robin", "numberofparticipants": 4, "fixturesdaterange": [1660678645445, 1661542645445], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"], "numOfMatches": 2, "participants": [], "conferences": [], "fixtures": [{"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-16T19:37:25.445Z", "scheduledtime": 1660678645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf331"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-17T13:24:05.445Z", "scheduledtime": 1660742645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf332"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-18T07:10:45.445Z", "scheduledtime": 1660806645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf333"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-19T00:57:25.445Z", "scheduledtime": 1660870645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf334"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-19T18:44:05.445Z", "scheduledtime": 1660934645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf335"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-20T12:30:45.445Z", "scheduledtime": 1660998645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf336"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-21T06:17:25.445Z", "scheduledtime": 1661062645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf337"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-22T00:04:05.445Z", "scheduledtime": 1661126645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf338"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-22T17:50:45.445Z", "scheduledtime": 1661190645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf339"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-23T11:37:25.445Z", "scheduledtime": 1661254645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf33a"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-24T05:24:05.445Z", "scheduledtime": 1661318645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf33b"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-24T23:10:45.445Z", "scheduledtime": 1661382645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf33c"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "md4lro64", "hostingChannel": null, "createdAt": "2022-08-16T18:37:37.537Z", "updatedAt": "2022-08-16T18:37:37.562Z", "__v": 0, "parameters": {"name": "Championship", "tournamentformat": "Round Robin", "numberofparticipants": 4, "forfeitScore": {"winner": 5, "loser": 0}, "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "numOfMatches": 2, "fixturesdaterange": [1660678645445, 1661542645445], "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"]}}, {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fbe3a293fc76b9854cf31e", "name": "Battle Royal Tournament", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Free For All", "minGroupSize": 3, "maxGroupSize": 4, "fixturesdaterange": [1660678568142, 1661542568142], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points"], "indexesRules": ["+Points"], "participants": [], "conferences": [], "fixtures": [{"participants": [], "scheduleddate": "2022-08-16T19:36:08.142Z", "scheduledtime": 1660678568142, "round": 1, "index": 1, "fixtureLabel": "A", "rescheduleHistory": [], "_id": "62fbe3a293fc76b9854cf31f"}, {"participants": [], "scheduleddate": "2022-08-20T03:36:08.142Z", "scheduledtime": 1660966568142, "round": 1, "index": 2, "fixtureLabel": "B", "rescheduleHistory": [], "_id": "62fbe3a293fc76b9854cf320"}, {"participants": [], "scheduleddate": "2022-08-23T11:36:08.142Z", "scheduledtime": 1661254568142, "round": 2, "index": 3, "rescheduleHistory": [], "_id": "62fbe3a293fc76b9854cf321"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "umn8wgy4", "hostingChannel": null, "qualifyingPerFixture": 2, "createdAt": "2022-08-16T18:36:18.754Z", "updatedAt": "2022-08-16T18:37:07.021Z", "__v": 4, "parameters": {"name": "Battle Royal Tournament", "tournamentformat": "Free For All", "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "discordGuildId": "12345", "indexes": ["Points"], "indexesRules": ["+Points"], "fixturesdaterange": [1660678568142, 1661542568142], "groupsNum": 2, "minGroupSize": 3, "maxGroupSize": 4, "qualifiedPerMatch": 2}}, {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fbdfe264e8d6fcefe1f2dd", "name": "Battle Royal Tournament", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Free For All", "minGroupSize": 3, "maxGroupSize": 4, "fixturesdaterange": [1660677601518, 1661541601518], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points"], "indexesRules": ["+Points"], "participants": [{"name": "United FC", "discordId": 12345, "group": "B", "stats": {"Points": 0}, "_id": "62fbe05564e8d6fcefe1f2f3"}, {"name": "City FC", "discordId": 12345, "group": "B", "stats": {"Points": 0}, "_id": "62fbe31d93fc76b9854cf314"}, {"name": "City FC", "discordId": 12345, "group": "A", "stats": {"Points": 0}, "_id": "62fbe33093fc76b9854cf319"}], "conferences": [], "fixtures": [{"participants": [], "scheduleddate": "2022-08-16T19:20:01.518Z", "scheduledtime": 1660677601518, "round": 1, "index": 1, "fixtureLabel": "A", "rescheduleHistory": [], "_id": "62fbdfe264e8d6fcefe1f2de"}, {"participants": [{"participantId": "62fbe04764e8d6fcefe1f2ed", "name": "Liverpool FC", "indexes": {"Points": 0}}, {"participantId": "62fbe05564e8d6fcefe1f2f3", "name": "United FC", "indexes": {"Points": 0}}], "scheduleddate": "2022-08-20T03:20:01.518Z", "scheduledtime": 1660965601518, "round": 1, "index": 2, "fixtureLabel": "B", "rescheduleHistory": [], "_id": "62fbdfe264e8d6fcefe1f2df"}, {"participants": [], "scheduleddate": "2022-08-23T11:20:01.518Z", "scheduledtime": 1661253601518, "round": 2, "index": 3, "rescheduleHistory": [], "_id": "62fbdfe264e8d6fcefe1f2e0"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "f4xzipj8", "hostingChannel": null, "qualifyingPerFixture": 2, "createdAt": "2022-08-16T18:20:18.737Z", "updatedAt": "2022-08-16T18:34:24.628Z", "__v": 11, "parameters": {"name": "Battle Royal Tournament", "tournamentformat": "Free For All", "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "discordGuildId": "12345", "indexes": ["Points"], "indexesRules": ["+Points"], "fixturesdaterange": [1660677601518, 1661541601518], "groupsNum": 2, "minGroupSize": 3, "maxGroupSize": 4, "qualifiedPerMatch": 2}}], "page": 1, "totalPages": 3}
{"type": "object", "properties": {"tournaments": {"type": "array", "items": {"type": "object"}}, "page": {"type": "integer"}, "totalPages": {"type": "integer"}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/4a14e906-9693-4754-82c2-5dbcdb3ed82f/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Retrieve participant's upcoming matches
Retrieve upcoming fixtures of a specific participant
200
Response
{"message": "The upcoming fixtures for the participant 62fbe896ed92d61a14ca690d", "upcomingFixtures": [{"participants": [{"participantId": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC", "indexes": {"Points": 3}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:04:58.470Z"}, {"participantId": "62fbe8b2ed92d61a14ca6913", "name": "City FC", "indexes": {"Points": 1}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:05:28.046Z"}, {"participantId": "62fbeaafe74cf7f71ad82e59", "name": "Paris FC", "indexes": {"Points": 0}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:06:07.500Z"}], "qualifyingparticipants": ["Liverpool FC"], "scheduleddate": "2022-08-20T03:56:40.258Z", "scheduledtime": 1660967800258, "round": 1, "index": 2, "fixtureLabel": "B", "modified": true, "rescheduleHistory": [], "_id": "62fbe872ed92d61a14ca6902"}, {"participants": [{"participantId": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC", "indexes": {"Points": 0}}], "scheduleddate": "2022-08-20T06:44:14.258Z", "scheduledtime": 1660977854258, "round": 2, "index": 3, "rescheduleHistory": ["1660977854258"], "_id": "62fbe872ed92d61a14ca6903"}]}
{"type": "object", "properties": {"message": {"type": "string"}, "upcomingFixtures": {"type": "array", "items": {"type": "object"}}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/47dd01a5-5865-4899-a1bd-3424530224d7/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Retrieve a tournament
Retrieve a tournament by its ID
200
Response
{"forfeitScore": {"winner": 5, "loser": 0}, "_id": "62fbe3f193fc76b9854cf330", "name": "Championship", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Round Robin", "numberofparticipants": 4, "fixturesdaterange": [1660678645445, 1661542645445], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"], "numOfMatches": 2, "participants": [], "conferences": [], "fixtures": [{"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-16T19:37:25.445Z", "scheduledtime": 1660678645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf331"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-17T13:24:05.445Z", "scheduledtime": 1660742645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf332"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-18T07:10:45.445Z", "scheduledtime": 1660806645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf333"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-19T00:57:25.445Z", "scheduledtime": 1660870645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf334"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-19T18:44:05.445Z", "scheduledtime": 1660934645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf335"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-20T12:30:45.445Z", "scheduledtime": 1660998645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf336"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-21T06:17:25.445Z", "scheduledtime": 1661062645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf337"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-22T00:04:05.445Z", "scheduledtime": 1661126645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf338"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-22T17:50:45.445Z", "scheduledtime": 1661190645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf339"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-23T11:37:25.445Z", "scheduledtime": 1661254645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf33a"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-24T05:24:05.445Z", "scheduledtime": 1661318645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf33b"}, {"tournamentid": "62fbe3f193fc76b9854cf330", "participant1": null, "participant2": null, "scheduleddate": "2022-08-24T23:10:45.445Z", "scheduledtime": 1661382645445, "rescheduleHistory": [], "_id": "62fbe3f193fc76b9854cf33c"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "md4lro64", "hostingChannel": null, "createdAt": "2022-08-16T18:37:37.537Z", "updatedAt": "2022-08-16T18:37:37.562Z", "__v": 0, "parameters": {"name": "Championship", "tournamentformat": "Round Robin", "numberofparticipants": 4, "forfeitScore": {"winner": 5, "loser": 0}, "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "numOfMatches": 2, "fixturesdaterange": [1660678645445, 1661542645445], "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"]}}
{"type": "object", "properties": {"forfeitScore": {"type": "object", "properties": {"winner": {"type": "integer"}, "loser": {"type": "integer"}}}, "_id": {"type": "string"}, "name": {"type": "string"}, "discordGuildRoles": {"type": "array"}, "dependencies": {"type": "array"}, "tournamentformat": {"type": "string"}, "numberofparticipants": {"type": "integer"}, "fixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "fixturesExpirationDelay": {"type": "integer"}, "checkInTimeout": {"type": "integer"}, "indexes": {"type": "array", "items": {"type": "string"}}, "indexesRules": {"type": "array", "items": {"type": "string"}}, "numOfMatches": {"type": "integer"}, "participants": {"type": "array"}, "conferences": {"type": "array"}, "fixtures": {"type": "array", "items": {"type": "object", "properties": {"tournamentid": {"type": "string"}, "participant1": {"type": "null"}, "participant2": {"type": "null"}, "scheduleddate": {"type": "string"}, "scheduledtime": {"type": "integer"}, "rescheduleHistory": {"type": "array"}, "_id": {"type": "string"}}}}, "app": {"type": "string"}, "manager": {"type": "string"}, "privacy": {"type": "string"}, "imageIllustrationUrl": {"type": "string"}, "matchmakingKey": {"type": "string"}, "hostingChannel": {"type": "null"}, "createdAt": {"type": "string"}, "updatedAt": {"type": "string"}, "__v": {"type": "integer"}, "parameters": {"type": "object", "properties": {"name": {"type": "string"}, "tournamentformat": {"type": "string"}, "numberofparticipants": {"type": "integer"}, "forfeitScore": {"type": "object", "properties": {"winner": {"type": "integer"}, "loser": {"type": "integer"}}}, "fixturesExpirationDelay": {"type": "integer"}, "checkInTimeout": {"type": "integer"}, "numOfMatches": {"type": "integer"}, "fixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "indexes": {"type": "array", "items": {"type": "string"}}, "indexesRules": {"type": "array", "items": {"type": "string"}}}}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/93b46c36-1763-4c2c-83ac-8136c0518440/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Delete tournament
Delete a tournament
200
Response
{"success": true, "doc": {"forfeitScore": {"winner": 3, "loser": 0}, "_id": "62fc0c2280738ded81599b73", "name": "National League", "discordGuildId": "12345", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "League", "conferences": [{"name": "Western Conference", "divisions": [{"name": "Pacific"}, {"name": "Northwest"}], "numberofparticipants": 4, "_id": "62fc0c2280738ded81599b74"}, {"name": "Eastern Conference", "divisions": [{"name": "Atlantic"}, {"name": "Central"}], "numberofparticipants": 4, "_id": "62fc0c2280738ded81599b75"}], "fixturesdaterange": [1660688916353, 1661552916353], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "indexes": ["Points"], "indexesRules": ["+Points"], "qualifyNumPerConference": 2, "playoffWinsNeeded": 2, "participants": [{"name": "Liverpool FC", "conference": "Western Conference", "division": "Pacific", "discordId": 12345, "stats": {"Points": 0}, "_id": "62fc0cb080738ded81599b7c"}, {"name": "Montreal Canadiens", "conference": "Eastern Conference", "division": "Atlantic", "stats": {"Points": 0}, "_id": "62fc0df79d6b02eb4659ca78"}], "fixtures": [], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "umdggcqi", "hostingChannel": null, "playoffFixturesdaterange": [1661642916353, 1662506916353], "sortByWinRate": false, "createdAt": "2022-08-16T21:29:06.603Z", "updatedAt": "2022-08-16T21:36:55.254Z", "__v": 2, "parameters": {"name": "National League", "tournamentformat": "League", "conferences": [{"name": "Western Conference", "numberofparticipants": 4, "divisions": [{"name": "Pacific"}, {"name": "Northwest"}]}, {"name": "Eastern Conference", "numberofparticipants": 4, "divisions": [{"name": "Atlantic"}, {"name": "Central"}]}], "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "discordGuildId": "12345", "indexes": ["Points"], "indexesRules": ["+Points"], "fixturesdaterange": [1660688916353, 1661552916353], "sameConferenceMatchesNum": 2, "qualifyNumPerConference": 2, "playoffWinsNeeded": 2, "againstConferenceMatchesNum": 1, "sameDivisionMatchesNum": 4, "playoffFixturesdaterange": [1661642916353, 1662506916353]}}}
{"type": "object", "properties": {"success": {"type": "boolean"}, "doc": {"type": "object", "properties": {"forfeitScore": {"type": "object", "properties": {"winner": {"type": "integer"}, "loser": {"type": "integer"}}}, "_id": {"type": "string"}, "name": {"type": "string"}, "discordGuildId": {"type": "string"}, "discordGuildRoles": {"type": "array"}, "dependencies": {"type": "array"}, "tournamentformat": {"type": "string"}, "conferences": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "divisions": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}}}}, "numberofparticipants": {"type": "integer"}, "_id": {"type": "string"}}}}, "fixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "fixturesExpirationDelay": {"type": "integer"}, "checkInTimeout": {"type": "integer"}, "indexes": {"type": "array", "items": {"type": "string"}}, "indexesRules": {"type": "array", "items": {"type": "string"}}, "qualifyNumPerConference": {"type": "integer"}, "playoffWinsNeeded": {"type": "integer"}, "participants": {"type": "array", "items": {"type": "object"}}, "fixtures": {"type": "array"}, "app": {"type": "string"}, "manager": {"type": "string"}, "privacy": {"type": "string"}, "imageIllustrationUrl": {"type": "string"}, "matchmakingKey": {"type": "string"}, "hostingChannel": {"type": "null"}, "playoffFixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "sortByWinRate": {"type": "boolean"}, "createdAt": {"type": "string"}, "updatedAt": {"type": "string"}, "__v": {"type": "integer"}, "parameters": {"type": "object", "properties": {"name": {"type": "string"}, "tournamentformat": {"type": "string"}, "conferences": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "numberofparticipants": {"type": "integer"}, "divisions": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}}}}}}}, "fixturesExpirationDelay": {"type": "integer"}, "checkInTimeout": {"type": "integer"}, "discordGuildId": {"type": "string"}, "indexes": {"type": "array", "items": {"type": "string"}}, "indexesRules": {"type": "array", "items": {"type": "string"}}, "fixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "sameConferenceMatchesNum": {"type": "integer"}, "qualifyNumPerConference": {"type": "integer"}, "playoffWinsNeeded": {"type": "integer"}, "againstConferenceMatchesNum": {"type": "integer"}, "sameDivisionMatchesNum": {"type": "integer"}, "playoffFixturesdaterange": {"type": "array", "items": {"type": "integer"}}}}}}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/f481576c-3cb4-4c02-b350-3a8749fbbe69/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Copy tournament
Create a new instance of a previous tournament.
200
Response
{"success": true, "newTournament": {"name": "My new tournament", "discordGuildRoles": [], "dependencies": [], "tournamentformat": "Round Robin", "numberofparticipants": 4, "fixturesdaterange": [1660701367862, 1661565367862], "fixturesExpirationDelay": 3600000, "forfeitScore": {"winner": 5, "loser": 0}, "checkInTimeout": 900000, "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"], "numOfMatches": 2, "_id": "62fc3cba2efe0a89b6586e05", "participants": [], "conferences": [], "fixtures": [{"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-17T01:56:07.862Z", "scheduledtime": 1660701367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e06"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-17T19:42:47.862Z", "scheduledtime": 1660765367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e07"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-18T13:29:27.862Z", "scheduledtime": 1660829367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e08"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-19T07:16:07.862Z", "scheduledtime": 1660893367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e09"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-20T01:02:47.862Z", "scheduledtime": 1660957367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0a"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-20T18:49:27.862Z", "scheduledtime": 1661021367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0b"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-21T12:36:07.862Z", "scheduledtime": 1661085367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0c"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-22T06:22:47.862Z", "scheduledtime": 1661149367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0d"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-23T00:09:27.862Z", "scheduledtime": 1661213367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0e"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-23T17:56:07.862Z", "scheduledtime": 1661277367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e0f"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-24T11:42:47.862Z", "scheduledtime": 1661341367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e10"}, {"tournamentid": "62fc3cba2efe0a89b6586e05", "participant1": null, "participant2": null, "scheduleddate": "2022-08-25T05:29:27.862Z", "scheduledtime": 1661405367862, "rescheduleHistory": [], "_id": "62fc3cba2efe0a89b6586e11"}], "app": "jackmatrix75", "manager": "jackmatrix75", "privacy": "public", "imageIllustrationUrl": "", "matchmakingKey": "8q3e76po", "hostingChannel": null, "createdAt": "2022-08-17T00:56:26.660Z", "updatedAt": "2022-08-17T00:56:26.684Z", "__v": 0, "parameters": {"name": "My new tournament", "tournamentformat": "Round Robin", "numberofparticipants": 4, "forfeitScore": {"winner": 5, "loser": 0}, "fixturesExpirationDelay": 3600000, "checkInTimeout": 900000, "numOfMatches": 2, "fixturesdaterange": [1660701367862, 1661565367862], "indexes": ["Points", "Goals", "Yellow Cards"], "indexesRules": ["+Points", "+Goals", "-Yellow Cards"]}}}
{"type": "object", "properties": {"success": {"type": "boolean"}, "newTournament": {"type": "object", "properties": {"name": {"type": "string"}, "discordGuildRoles": {"type": "array"}, "dependencies": {"type": "array"}, "tournamentformat": {"type": "string"}, "numberofparticipants": {"type": "integer"}, "fixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "fixturesExpirationDelay": {"type": "integer"}, "forfeitScore": {"type": "object", "properties": {"winner": {"type": "integer"}, "loser": {"type": "integer"}}}, "checkInTimeout": {"type": "integer"}, "indexes": {"type": "array", "items": {"type": "string"}}, "indexesRules": {"type": "array", "items": {"type": "string"}}, "numOfMatches": {"type": "integer"}, "_id": {"type": "string"}, "participants": {"type": "array"}, "conferences": {"type": "array"}, "fixtures": {"type": "array", "items": {"type": "object", "properties": {"tournamentid": {"type": "string"}, "participant1": {"type": "null"}, "participant2": {"type": "null"}, "scheduleddate": {"type": "string"}, "scheduledtime": {"type": "integer"}, "rescheduleHistory": {"type": "array"}, "_id": {"type": "string"}}}}, "app": {"type": "string"}, "manager": {"type": "string"}, "privacy": {"type": "string"}, "imageIllustrationUrl": {"type": "string"}, "matchmakingKey": {"type": "string"}, "hostingChannel": {"type": "null"}, "createdAt": {"type": "string"}, "updatedAt": {"type": "string"}, "__v": {"type": "integer"}, "parameters": {"type": "object", "properties": {"name": {"type": "string"}, "tournamentformat": {"type": "string"}, "numberofparticipants": {"type": "integer"}, "forfeitScore": {"type": "object", "properties": {"winner": {"type": "integer"}, "loser": {"type": "integer"}}}, "fixturesExpirationDelay": {"type": "integer"}, "checkInTimeout": {"type": "integer"}, "numOfMatches": {"type": "integer"}, "fixturesdaterange": {"type": "array", "items": {"type": "integer"}}, "indexes": {"type": "array", "items": {"type": "string"}}, "indexesRules": {"type": "array", "items": {"type": "string"}}}}}}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/a64be3c1-c0bd-4246-92d6-e701851f5776/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Score report
Report score of the match.
200
Response
{"message": [[{"success": 1, "fails": 0}, {"fixtureId": "62fbe872ed92d61a14ca6902", "response": {"message": "The fixture was updated successfully", "fixture": {"participants": [{"participantId": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC", "indexes": {"Points": 3}, "checkInTime": "2022-08-17T00:04:58.470Z", "areIndexesModified": true}, {"participantId": "62fbe8b2ed92d61a14ca6913", "name": "City FC", "indexes": {"Points": 0}, "checkInTime": "2022-08-17T00:05:28.046Z"}, {"participantId": "62fbeaafe74cf7f71ad82e59", "name": "Paris FC", "indexes": {"Points": 0}, "checkInTime": "2022-08-17T00:06:07.500Z"}], "scheduleddate": "2022-08-20T03:56:40.258Z", "scheduledtime": 1660967800258, "round": 1, "index": 2, "fixtureLabel": "B", "rescheduleHistory": [], "_id": "62fbe872ed92d61a14ca6902", "modified": true}}}], [{"success": 1, "fails": 0}, {"fixtureId": "62fbe872ed92d61a14ca6902", "response": {"message": "The fixture was updated successfully", "fixture": {"participants": [{"participantId": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC", "indexes": {"Points": 3}, "areIndexesModified": true, "checkInTime": "2022-08-17T00:04:58.470Z"}, {"participantId": "62fbe8b2ed92d61a14ca6913", "name": "City FC", "indexes": {"Points": 1}, "checkInTime": "2022-08-17T00:05:28.046Z", "areIndexesModified": true}, {"participantId": "62fbeaafe74cf7f71ad82e59", "name": "Paris FC", "indexes": {"Points": 0}, "checkInTime": "2022-08-17T00:06:07.500Z"}], "scheduleddate": "2022-08-20T03:56:40.258Z", "scheduledtime": 1660967800258, "round": 1, "index": 2, "fixtureLabel": "B", "modified": true, "rescheduleHistory": [], "_id": "62fbe872ed92d61a14ca6902"}}}], [{"success": 1, "fails": 0}, {"fixtureId": "62fbe872ed92d61a14ca6902", "response": {"message": "The fixture has ended and the following participant advanced to the next fixture.", "participants": [{"_id": "62fbe896ed92d61a14ca690d", "name": "Liverpool FC"}]}}]]}
{"type": "object", "properties": {"message": {"type": "array", "items": {"type": "array", "items": {"type": "object"}}}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/854c6f61-dd2f-4326-ad3f-e08f674be893/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Add participant
Add a participant to the tournament
200
Response
{"message": "Participant was added successfully.", "participants": [{"name": "Liverpool FC", "discordId": 12345, "group": "C", "stats": {"Points": 0, "Goals": 0, "Yellow Cards": 0}, "_id": "62fa95164ab34dc791ae5b90"}]}
{"type": "object", "properties": {"message": {"type": "string"}, "participants": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "discordId": {"type": "integer"}, "group": {"type": "string"}, "stats": {"type": "object", "properties": {"Points": {"type": "integer"}, "Goals": {"type": "integer"}, "Yellow Cards": {"type": "integer"}}}, "_id": {"type": "string"}}}}}}
984e1681-43a4-47ba-9a52-77f2c3ee6648/d7ba340b-7ab0-44f5-b6cf-00277433d849/0/0
Esport Tournament Engine
A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand.
null
Reschedule match
This endpoint enables you to reschedule a fixture
200
Response
{"message": "The fixture with id 62fbe872ed92d61a14ca6903 was successfully rescheduled.", "rescheduleDate": 1660977854258}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}, "rescheduleDate": {"type": "integer"}}, "required": ["message", "rescheduleDate"]}