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
16c8830d-71af-4af5-aba8-0ef86b89ed6a/ebcf3bd0-5376-4109-8b4f-598d57e225b0/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_event_types_api_v1_event_type__get
Return the list of event types.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/ebcf3bd0-5376-4109-8b4f-598d57e225b0/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_event_types_api_v1_event_type__get
Return the list of event types.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/ebcf3bd0-5376-4109-8b4f-598d57e225b0/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_event_types_api_v1_event_type__get
Return the list of event types.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/ebcf3bd0-5376-4109-8b4f-598d57e225b0/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_event_types_api_v1_event_type__get
Return the list of event types.
200
null
{"data": [{"description": "A user has signed up", "schemas": {"example": {"invoiceId": "", "userId": ""}}, "archived": false, "name": "user.signup", "createdAt": "", "updatedAt": ""}], "iterator": "iterator", "done": true}
{"title": "ListResponse[EventTypeOut]", "required": ["data", "done"], "type": "object", "properties": {"data": {"title": "Data", "type": "array", "items": {"title": "EventTypeOut", "required": ["description", "name", "createdAt", "updatedAt"], "type": "object", "properties": {"description": {"title": "Description", "type": "string"}, "schemas": {"title": "Schemas", "type": "object", "additionalProperties": {"type": "object"}, "description": "The schema for the event type for a specific version as a JSON schema."}, "archived": {"title": "Archived", "type": "boolean", "default": false}, "name": {"title": "Name", "maxLength": 256, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}}, "iterator": {"title": "Iterator", "type": "string"}, "done": {"title": "Done", "type": "boolean"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/7a814299-2612-4336-ac0a-e5f70d5e035a/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_endpoint_api_v1_app__app_id__endpoint__post
Create a new endpoint for the application. When secret is null the secret is automatically generated (recommended)
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/7a814299-2612-4336-ac0a-e5f70d5e035a/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_endpoint_api_v1_app__app_id__endpoint__post
Create a new endpoint for the application. When secret is null the secret is automatically generated (recommended)
201
null
{"uid": "unique-endpoint-identifier", "url": "https://example.com/webhook/", "version": 1, "description": "An example endpoint name", "filterTypes": [], "channels": ["project_1337"], "disabled": false, "rateLimit": 1000, "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}
{"title": "EndpointOut", "required": ["url", "version", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"uid": {"title": "Uid", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string", "description": "Optional unique identifier for the endpoint"}, "url": {"title": "Url", "maxLength": 65536, "minLength": 1, "type": "string", "format": "uri"}, "version": {"title": "Version", "exclusiveMinimum": false, "type": "integer"}, "description": {"title": "Description", "type": "string", "default": ""}, "filterTypes": {"title": "Filtertypes", "minItems": 1, "uniqueItems": true, "type": "array", "items": {"type": "string"}}, "channels": {"title": "Channels", "maxItems": 10, "minItems": 1, "uniqueItems": true, "type": "array", "items": {"maxLength": 128, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string"}, "description": "List of message channels this endpoint listens to (omit for all)"}, "disabled": {"title": "Disabled", "type": "boolean", "default": false}, "rateLimit": {"title": "Ratelimit", "exclusiveMinimum": false, "type": "integer"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/7a814299-2612-4336-ac0a-e5f70d5e035a/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_endpoint_api_v1_app__app_id__endpoint__post
Create a new endpoint for the application. When secret is null the secret is automatically generated (recommended)
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/7a814299-2612-4336-ac0a-e5f70d5e035a/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_endpoint_api_v1_app__app_id__endpoint__post
Create a new endpoint for the application. When secret is null the secret is automatically generated (recommended)
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/7a814299-2612-4336-ac0a-e5f70d5e035a/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_endpoint_api_v1_app__app_id__endpoint__post
Create a new endpoint for the application. When secret is null the secret is automatically generated (recommended)
422
null
{"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": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/7a814299-2612-4336-ac0a-e5f70d5e035a/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_endpoint_api_v1_app__app_id__endpoint__post
Create a new endpoint for the application. When secret is null the secret is automatically generated (recommended)
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2675acdf-f7a4-4478-bd39-32a44ce26842/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_endpoints_api_v1_app__app_id__endpoint__get
List the application's endpoints.
422
null
{"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": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2675acdf-f7a4-4478-bd39-32a44ce26842/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_endpoints_api_v1_app__app_id__endpoint__get
List the application's endpoints.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2675acdf-f7a4-4478-bd39-32a44ce26842/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_endpoints_api_v1_app__app_id__endpoint__get
List the application's endpoints.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2675acdf-f7a4-4478-bd39-32a44ce26842/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_endpoints_api_v1_app__app_id__endpoint__get
List the application's endpoints.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2675acdf-f7a4-4478-bd39-32a44ce26842/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_endpoints_api_v1_app__app_id__endpoint__get
List the application's endpoints.
200
null
{"data": [{"uid": "unique-endpoint-identifier", "url": "https://example.com/webhook/", "version": 1, "description": "An example endpoint name", "filterTypes": [], "channels": ["project_1337"], "disabled": false, "rateLimit": 1000, "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}], "iterator": "iterator", "done": true}
{"title": "ListResponse[EndpointOut]", "required": ["data", "done"], "type": "object", "properties": {"data": {"title": "Data", "type": "array", "items": {"title": "EndpointOut", "required": ["url", "version", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"uid": {"title": "Uid", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string", "description": "Optional unique identifier for the endpoint"}, "url": {"title": "Url", "maxLength": 65536, "minLength": 1, "type": "string", "format": "uri"}, "version": {"title": "Version", "exclusiveMinimum": false, "type": "integer"}, "description": {"title": "Description", "type": "string", "default": ""}, "filterTypes": {"title": "Filtertypes", "minItems": 1, "uniqueItems": true, "type": "array", "items": {"type": "string"}}, "channels": {"title": "Channels", "maxItems": 10, "minItems": 1, "uniqueItems": true, "type": "array", "items": {"maxLength": 128, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string"}, "description": "List of message channels this endpoint listens to (omit for all)"}, "disabled": {"title": "Disabled", "type": "boolean", "default": false}, "rateLimit": {"title": "Ratelimit", "exclusiveMinimum": false, "type": "integer"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}}, "iterator": {"title": "Iterator", "type": "string"}, "done": {"title": "Done", "type": "boolean"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/2675acdf-f7a4-4478-bd39-32a44ce26842/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_endpoints_api_v1_app__app_id__endpoint__get
List the application's endpoints.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/55157f09-e33b-4f58-98be-d47fc0868e8b/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_event_type_api_v1_event_type__event_type_name___put
Update an event type.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/55157f09-e33b-4f58-98be-d47fc0868e8b/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_event_type_api_v1_event_type__event_type_name___put
Update an event type.
200
null
{"description": "A user has signed up", "schemas": {"example": {"invoiceId": "", "userId": ""}}, "archived": false, "name": "user.signup", "createdAt": "", "updatedAt": ""}
{"title": "EventTypeOut", "required": ["description", "name", "createdAt", "updatedAt"], "type": "object", "properties": {"description": {"title": "Description", "type": "string"}, "schemas": {"title": "Schemas", "type": "object", "additionalProperties": {"type": "object"}, "description": "The schema for the event type for a specific version as a JSON schema."}, "archived": {"title": "Archived", "type": "boolean", "default": false}, "name": {"title": "Name", "maxLength": 256, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/55157f09-e33b-4f58-98be-d47fc0868e8b/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_event_type_api_v1_event_type__event_type_name___put
Update an event type.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/55157f09-e33b-4f58-98be-d47fc0868e8b/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_event_type_api_v1_event_type__event_type_name___put
Update an event type.
422
null
{"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": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/55157f09-e33b-4f58-98be-d47fc0868e8b/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_event_type_api_v1_event_type__event_type_name___put
Update an event type.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/55157f09-e33b-4f58-98be-d47fc0868e8b/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
update_event_type_api_v1_event_type__event_type_name___put
Update an event type.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/e2d58e24-d963-478c-8e99-df3788906617/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_event_type_api_v1_event_type__event_type_name___delete
Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the create operation.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/e2d58e24-d963-478c-8e99-df3788906617/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_event_type_api_v1_event_type__event_type_name___delete
Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the create operation.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/e2d58e24-d963-478c-8e99-df3788906617/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_event_type_api_v1_event_type__event_type_name___delete
Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the create operation.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/e2d58e24-d963-478c-8e99-df3788906617/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_event_type_api_v1_event_type__event_type_name___delete
Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the create operation.
422
null
{"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": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/e2d58e24-d963-478c-8e99-df3788906617/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
delete_event_type_api_v1_event_type__event_type_name___delete
Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the create operation.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/82de4ba6-89ee-4cff-a97e-e2c3080a3f38/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
recover_failed_webhooks_api_v1_app__app_id__endpoint__endpoint_id__recover__post
Resend all failed messages since a given time.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/82de4ba6-89ee-4cff-a97e-e2c3080a3f38/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
recover_failed_webhooks_api_v1_app__app_id__endpoint__endpoint_id__recover__post
Resend all failed messages since a given time.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/82de4ba6-89ee-4cff-a97e-e2c3080a3f38/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
recover_failed_webhooks_api_v1_app__app_id__endpoint__endpoint_id__recover__post
Resend all failed messages since a given time.
422
null
{"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": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/82de4ba6-89ee-4cff-a97e-e2c3080a3f38/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
recover_failed_webhooks_api_v1_app__app_id__endpoint__endpoint_id__recover__post
Resend all failed messages since a given time.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/82de4ba6-89ee-4cff-a97e-e2c3080a3f38/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
recover_failed_webhooks_api_v1_app__app_id__endpoint__endpoint_id__recover__post
Resend all failed messages since a given time.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/32b4c72b-2524-458b-9fa2-54d9013d4f15/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_applications_api_v1_app__get
List of all the organization's applications.
200
null
{"data": [{"uid": "unique-app-identifier", "name": "My first application", "rateLimit": 1000, "id": "app_1srOrx2ZWZBpBUvZwXKQmoEYga2", "createdAt": "", "updatedAt": ""}], "iterator": "iterator", "done": true}
{"title": "ListResponse[ApplicationOut]", "required": ["data", "done"], "type": "object", "properties": {"data": {"title": "Data", "type": "array", "items": {"title": "ApplicationOut", "required": ["name", "id", "createdAt", "updatedAt"], "type": "object", "properties": {"uid": {"title": "Uid", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string", "description": "Optional unique identifier for the application"}, "name": {"title": "Name", "type": "string"}, "rateLimit": {"title": "Ratelimit", "exclusiveMinimum": false, "type": "integer"}, "id": {"title": "Id", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}}, "iterator": {"title": "Iterator", "type": "string"}, "done": {"title": "Done", "type": "boolean"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/32b4c72b-2524-458b-9fa2-54d9013d4f15/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_applications_api_v1_app__get
List of all the organization's applications.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/32b4c72b-2524-458b-9fa2-54d9013d4f15/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_applications_api_v1_app__get
List of all the organization's applications.
422
null
{"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": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/32b4c72b-2524-458b-9fa2-54d9013d4f15/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_applications_api_v1_app__get
List of all the organization's applications.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/32b4c72b-2524-458b-9fa2-54d9013d4f15/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_applications_api_v1_app__get
List of all the organization's applications.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/32b4c72b-2524-458b-9fa2-54d9013d4f15/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
list_applications_api_v1_app__get
List of all the organization's applications.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5e91e680-a0cd-4aff-9793-1b14d7a0b2e7/0/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_event_type_api_v1_event_type__post
Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas.
201
null
{"description": "A user has signed up", "schemas": {"example": {"invoiceId": "", "userId": ""}}, "archived": false, "name": "user.signup", "createdAt": "", "updatedAt": ""}
{"title": "EventTypeOut", "required": ["description", "name", "createdAt", "updatedAt"], "type": "object", "properties": {"description": {"title": "Description", "type": "string"}, "schemas": {"title": "Schemas", "type": "object", "additionalProperties": {"type": "object"}, "description": "The schema for the event type for a specific version as a JSON schema."}, "archived": {"title": "Archived", "type": "boolean", "default": false}, "name": {"title": "Name", "maxLength": 256, "pattern": "^[a-zA-Z0-9\\-_.]+$", "type": "string"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updatedAt": {"title": "Updatedat", "type": "string", "format": "date-time"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5e91e680-a0cd-4aff-9793-1b14d7a0b2e7/1/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_event_type_api_v1_event_type__post
Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas.
404
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5e91e680-a0cd-4aff-9793-1b14d7a0b2e7/2/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_event_type_api_v1_event_type__post
Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas.
409
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5e91e680-a0cd-4aff-9793-1b14d7a0b2e7/3/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_event_type_api_v1_event_type__post
Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas.
403
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5e91e680-a0cd-4aff-9793-1b14d7a0b2e7/4/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_event_type_api_v1_event_type__post
Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas.
401
null
{"code": "", "detail": ""}
{"title": "HttpError", "required": ["code", "detail"], "type": "object", "properties": {"code": {"title": "Code", "type": "string"}, "detail": {"title": "Detail", "type": "string"}}}
16c8830d-71af-4af5-aba8-0ef86b89ed6a/5e91e680-a0cd-4aff-9793-1b14d7a0b2e7/5/0
Svix
Webhooks as a Service. Build a secure, reliable, scalable webhooks service with Svix Webhooks API.
null
create_event_type_api_v1_event_type__post
Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas.
422
null
{"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": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}
65cf743d-b809-4208-aa0f-716704e2af51/55a3bed7-9ba0-48ed-94d6-23dfe99125ee/0/0
US Sales Tax Rate By Zipcode
Sales tax calculation based on ZIPCODE Provide realtime and accurate US Sales Tax Rate by Zipcode. (FREE TRIAL)
8.7
salestax_rate
Returns detailed sales tax data given the zip_code. Request Body: { "zip_code": "10010" } Output: { "combined": { // total taxes "text": "8.875% (Combined)", "value": "0.08875" }, "rate_Special": { "text": "0.375% (Special)", "value": "0.00375" }, "rate_State": { "text": "4% (State)", "value": "0.04000" }, "rate_City": { "text": "4.5% (City)", "value": "0.04500" } }
200
Response
{"rate_Special": {"text": "0.375% (Special)", "value": "0.00375"}, "rate_State": {"text": "4% (State)", "value": "0.04000"}, "rate_City": {"text": "4.5% (City)", "value": "0.04500"}, "combined": {"text": "8.875% (Combined)", "value": "0.08875"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"rate_Special": {"type": "object", "properties": {"text": {"type": "string"}, "value": {"type": "string"}}, "required": ["text", "value"]}, "rate_State": {"type": "object", "properties": {"text": {"type": "string"}, "value": {"type": "string"}}, "required": ["text", "value"]}, "rate_City": {"type": "object", "properties": {"text": {"type": "string"}, "value": {"type": "string"}}, "required": ["text", "value"]}, "combined": {"type": "object", "properties": {"text": {"type": "string"}, "value": {"type": "string"}}, "required": ["text", "value"]}}, "required": ["combined", "rate_City", "rate_Special", "rate_State"]}
af424652-0fc5-456f-bf46-766e87d78549/b9a9b7cf-6ce0-4b51-b5eb-0c6e5fcbd9eb/1/0
TEST_USER_A001
Test User Formatting Type 1
null
User
Test
100
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
5a89c786-887e-4add-a103-1b37ff6a0010/2cdbcf9b-cd24-4831-b873-4931ed8f82dc/0/0
QR Code Logo Generator
To embed (add) a logo to an existing image for example a QR Code
null
QR Code Logo Embed
AI to add a logo to an existing QR Code. This logo can be placed in any location and of varying size or transparency. QR Logo Features Add Logo Custom custom sized Logo Custom Location Logo Apply to any image Add multiple Logo's
200
New Example
{"response": "", "status": "", "errcode": "", "currentsessions": "", "expiry": ""}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"response": {"type": "string"}, "status": {"type": "string"}, "errcode": {"type": "string"}, "currentsessions": {"type": "string"}, "expiry": {"type": "string"}}, "required": ["currentsessions", "errcode", "expiry", "response", "status"]}
d50f5e84-b8dd-46b5-8f12-ef9bcaf08192/910cec33-7327-44df-88fc-008f0a9d99cd/0/0
hash tags generator
generate hashtags for twitter instagram any other social medias
null
Get Hashtags
Pleace Enter Hashtag you want to Generate Hashtags
200
New Example
{"data": " #chess #chessboard #chessgame #chessplayer #chessmoves #chessmaster #chesslover #checkmate #chesslife #ajedrez #chesspuzzle #chesspiece #chessclub #chesstactics #chessnotcheckers #chesstournament #schach #chessproblems #chessset #xadrez #echecs #chesspuzzles #chessislife #magnuscarlsen #scacchi #fide #chessiesofinstagram #chesslove #grandmaster #chessmemes #art #chessgames #chesstime #chessplayers #playchess #game #gameofchess #chesspieces #boardgames #chessquotes #chesscom #schack #sjakk #love #lichess #catur #king #satran #games #chessnews #chesslessons #puzzle #chessman #photography #chesslovers #pawn #queen #chessbaseindia #chessmate #chessbase#chess #queen #game #games #king #puzzle #boardgames #chess #xadrez #checkmate #ajedrez #chessboard #chesse #grandmaster #chessecake #chessgame #pawn #chessplayer #chessa #chessiesofinstagram #chessie#chess #xadrez #checkmate #ajedrez #chessboard #chesse #grandmaster #chessecake #chessgame #pawn #chessplayer #chessa #chessiesofinstagram #chessie #chessnotcheckers #schach #chessington #chesspiece #scacchi #chessy #Chessmoves#chess #chessboard #chesse #chessecake #chessgame #chessplayer #chessa #chessiesofinstagram #chessie #chessnotcheckers #chessington #chesspiece #chessy #Chessmoves #chessmaster #chessclub #chessset #chesslover #chesstournament #chessingtonworldofadventures #chesscake"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"data": {"type": "string"}}, "required": ["data"]}
feed383d-876e-46ce-8a2c-5ae7c5885be7/c363aab9-4c79-4bfc-9191-b9e0b00b5aae/2/0
My API 12345
YUI
null
findPetsByTags
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
200
null
[{"id": 0, "category": {"id": 0, "name": ""}, "name": "doggie", "photoUrls": [], "tags": [{"id": 0, "name": ""}], "status": "available"}]
{"type": "array", "items": {"type": "object", "required": ["name", "photoUrls"], "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "category": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "name": {"type": "string"}}}, "name": {"type": "string"}, "photoUrls": {"type": "array", "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "name": {"type": "string"}}}}, "status": {"type": "string", "description": "pet status in the store", "enum": ["available", "pending", "sold"]}}}}
feed383d-876e-46ce-8a2c-5ae7c5885be7/7e257adb-2727-4746-ac31-151d5c630635/3/0
My API 12345
YUI
null
getOrderById
For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions
200
null
{"id": 0, "petId": 0, "quantity": 0, "shipDate": "", "status": "placed", "complete": true}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "petId": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "quantity": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "shipDate": {"type": "string", "format": "date-time"}, "status": {"type": "string", "description": "Order Status", "enum": ["placed", "approved", "delivered"]}, "complete": {"type": "boolean"}}}
feed383d-876e-46ce-8a2c-5ae7c5885be7/574c2b81-8ea6-4a35-931f-12f891ba16dc/0/0
My API 12345
YUI
null
uploadFile
200
null
{"code": 0, "type": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "type": {"type": "string"}, "message": {"type": "string"}}}
feed383d-876e-46ce-8a2c-5ae7c5885be7/c5c22ce3-fced-4c18-91fa-aba77e7ee7bf/3/0
My API 12345
YUI
null
getUserByName
200
null
{"id": 0, "username": "", "firstName": "", "lastName": "", "email": "", "password": "", "phone": "", "userStatus": 0}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "username": {"type": "string"}, "firstName": {"type": "string"}, "lastName": {"type": "string"}, "email": {"type": "string"}, "password": {"type": "string"}, "phone": {"type": "string"}, "userStatus": {"type": "integer", "format": "int32", "description": "User Status", "minimum": -2147483648, "maximum": 2147483647}}}
feed383d-876e-46ce-8a2c-5ae7c5885be7/6d35e166-fddd-4370-a698-6f6667541482/2/0
My API 12345
YUI
null
getPetById
Returns a single pet
200
null
{"id": 0, "category": {"id": 0, "name": ""}, "name": "doggie", "photoUrls": [], "tags": [{"id": 0, "name": ""}], "status": "available"}
{"type": "object", "required": ["name", "photoUrls"], "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "category": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "name": {"type": "string"}}}, "name": {"type": "string"}, "photoUrls": {"type": "array", "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "name": {"type": "string"}}}}, "status": {"type": "string", "description": "pet status in the store", "enum": ["available", "pending", "sold"]}}}
feed383d-876e-46ce-8a2c-5ae7c5885be7/6ea740a7-b1fa-4de6-9cde-8ccced0e866d/2/0
My API 12345
YUI
null
findPetsByStatus
Multiple status values can be provided with comma separated strings
200
null
[{"id": 0, "category": {"id": 0, "name": ""}, "name": "doggie", "photoUrls": [], "tags": [{"id": 0, "name": ""}], "status": "available"}]
{"type": "array", "items": {"type": "object", "required": ["name", "photoUrls"], "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "category": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "name": {"type": "string"}}}, "name": {"type": "string"}, "photoUrls": {"type": "array", "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "name": {"type": "string"}}}}, "status": {"type": "string", "description": "pet status in the store", "enum": ["available", "pending", "sold"]}}}}
feed383d-876e-46ce-8a2c-5ae7c5885be7/7dc0e072-3fce-465d-a4ab-8f348b623dd7/2/0
My API 12345
YUI
null
placeOrder
200
null
{"id": 0, "petId": 0, "quantity": 0, "shipDate": "", "status": "placed", "complete": true}
{"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "petId": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "quantity": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "shipDate": {"type": "string", "format": "date-time"}, "status": {"type": "string", "description": "Order Status", "enum": ["placed", "approved", "delivered"]}, "complete": {"type": "boolean"}}}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/93224e6c-b31d-43b1-83e0-e65278f3d4fa/0/0
UpLead
B2B company and contact data.
null
Combined API
Our Combined (Person + Company) API lets you lookup a person and company simultaneously based on an email address. The endpoint requires an email address and you get both the person and company information.
200
Example success response
{"data": {"city": "San Francisco", "company": {"address": "415 Mission Street, 3rd Floor", "alexa_rank": 123, "city": "San Francisco", "company_name": "Salesforce.com, Inc.", "country": "United States", "county": "San Francisco", "crunchbase_url": "https://www.crunchbase.com/organization/salesforce", "description": "Salesforce.com, Inc. is an American cloud-based software company, headquartered in San Francisco, California. Though the bulk of its revenue comes from a customer relationship management (CRM) product, Salesforce also sells a complementary suite of enterprise applications focused on customer service, marketing automation, analytics and application development.", "domain": "salesforce.com", "employees": "Over 10,000", "exchange": "NYSE", "facebook_url": "https://www.facebook.com/salesforce", "fax_number": "4159017040", "id": "c7d44d9a-b84a-459a-9003-75e10415f74a", "industry": "Internet", "instagram_url": "https://instagram.com/salesforce/", "linkedin_url": "https://www.linkedin.com/company/salesforce", "logo": "https://logo.uplead.com/salesforce.com", "naics_code": 518210, "naics_description": "Data Processing, Hosting, and Related Services", "phone_number": "4159017000", "revenue": "Over $1 Billion", "sic_code": 7372, "sic_description": "Prepackaged Software", "state": "CA", "ticker": "CRM", "twitter_url": "http://twitter.com/salesforce", "type": "Public", "year_founded": 1999, "yelp_url": "https://www.yelp.com/biz/salesforce-san-francisco", "youtube_url": "https://www.youtube.com/user/salesforce", "zip": 94105}, "country": "United States", "email": "[email protected]", "email_status": "valid", "first_name": "marc", "gender": "male", "id": "d98e157e-c31d-40a0-9d98-b2fb8390797d", "job_function": "", "last_name": "benioff", "linkedin_url": "https://www.linkedin.com/in/marcbenioff/", "management_level": "c_level", "state": "CA", "title": "ceo"}}
{"properties": {"data": {"properties": {"city": {"type": "string"}, "company": {"properties": {"address": {"type": "string"}, "alexa_rank": {"type": "integer"}, "city": {"type": "string"}, "company_name": {"type": "string"}, "country": {"type": "string"}, "county": {"type": "string"}, "crunchbase_url": {"type": "string"}, "description": {"type": "string"}, "domain": {"type": "string"}, "employees": {"type": "string"}, "exchange": {"type": "string"}, "facebook_url": {"type": "string"}, "fax_number": {"type": "string"}, "id": {"type": "string"}, "industry": {"type": "string"}, "instagram_url": {"type": "string"}, "linkedin_url": {"type": "string"}, "logo": {"type": "string"}, "naics_code": {"type": "integer"}, "naics_description": {"type": "string"}, "phone_number": {"type": "string"}, "revenue": {"type": "string"}, "sic_code": {"type": "integer"}, "sic_description": {"type": "string"}, "state": {"type": "string"}, "ticker": {"type": "string"}, "twitter_url": {"type": "string"}, "type": {"type": "string"}, "year_founded": {"type": "integer"}, "yelp_url": {"type": "string"}, "youtube_url": {"type": "string"}, "zip": {"type": "integer"}}, "type": "object"}, "country": {"type": "string"}, "email": {"type": "string"}, "email_status": {"type": "string"}, "first_name": {"type": "string"}, "gender": {"type": "string"}, "id": {"type": "string"}, "job_function": {"type": "string"}, "last_name": {"type": "string"}, "linkedin_url": {"type": "string"}, "management_level": {"type": "string"}, "state": {"type": "string"}, "title": {"type": "string"}}, "type": [["object", "null"]]}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/93224e6c-b31d-43b1-83e0-e65278f3d4fa/0/1
UpLead
B2B company and contact data.
null
Combined API
Our Combined (Person + Company) API lets you lookup a person and company simultaneously based on an email address. The endpoint requires an email address and you get both the person and company information.
200
Not found
{"data": null}
{"properties": {"data": {"properties": {"city": {"type": "string"}, "company": {"properties": {"address": {"type": "string"}, "alexa_rank": {"type": "integer"}, "city": {"type": "string"}, "company_name": {"type": "string"}, "country": {"type": "string"}, "county": {"type": "string"}, "crunchbase_url": {"type": "string"}, "description": {"type": "string"}, "domain": {"type": "string"}, "employees": {"type": "string"}, "exchange": {"type": "string"}, "facebook_url": {"type": "string"}, "fax_number": {"type": "string"}, "id": {"type": "string"}, "industry": {"type": "string"}, "instagram_url": {"type": "string"}, "linkedin_url": {"type": "string"}, "logo": {"type": "string"}, "naics_code": {"type": "integer"}, "naics_description": {"type": "string"}, "phone_number": {"type": "string"}, "revenue": {"type": "string"}, "sic_code": {"type": "integer"}, "sic_description": {"type": "string"}, "state": {"type": "string"}, "ticker": {"type": "string"}, "twitter_url": {"type": "string"}, "type": {"type": "string"}, "year_founded": {"type": "integer"}, "yelp_url": {"type": "string"}, "youtube_url": {"type": "string"}, "zip": {"type": "integer"}}, "type": "object"}, "country": {"type": "string"}, "email": {"type": "string"}, "email_status": {"type": "string"}, "first_name": {"type": "string"}, "gender": {"type": "string"}, "id": {"type": "string"}, "job_function": {"type": "string"}, "last_name": {"type": "string"}, "linkedin_url": {"type": "string"}, "management_level": {"type": "string"}, "state": {"type": "string"}, "title": {"type": "string"}}, "type": [["object", "null"]]}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/93224e6c-b31d-43b1-83e0-e65278f3d4fa/1/0
UpLead
B2B company and contact data.
null
Combined API
Our Combined (Person + Company) API lets you lookup a person and company simultaneously based on an email address. The endpoint requires an email address and you get both the person and company information.
401
Missing or invalid UpLead API key
{"error": "Please provide an API key."}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/93224e6c-b31d-43b1-83e0-e65278f3d4fa/2/0
UpLead
B2B company and contact data.
null
Combined API
Our Combined (Person + Company) API lets you lookup a person and company simultaneously based on an email address. The endpoint requires an email address and you get both the person and company information.
403
Insufficient credits
{"error": "You don't have enough credits"}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/93224e6c-b31d-43b1-83e0-e65278f3d4fa/3/0
UpLead
B2B company and contact data.
null
Combined API
Our Combined (Person + Company) API lets you lookup a person and company simultaneously based on an email address. The endpoint requires an email address and you get both the person and company information.
400
Invalid params
{"errors": ["email is missing"]}
{"properties": {"errors": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/3cb92ea0-727a-4cef-9a61-595e2db9c917/0/0
UpLead
B2B company and contact data.
null
Company API
Our Company API lets you lookup company data via a domain name or company name. You get a full overview of the company including size, location, social links, description, and more. For precise results it’s recommended to use a domain name.
400
Invalid params
{"errors": ["'company' or 'domain' is required"]}
{"properties": {"errors": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/3cb92ea0-727a-4cef-9a61-595e2db9c917/1/0
UpLead
B2B company and contact data.
null
Company API
Our Company API lets you lookup company data via a domain name or company name. You get a full overview of the company including size, location, social links, description, and more. For precise results it’s recommended to use a domain name.
403
Insufficient credits
{"error": "You don't have enough credits"}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/3cb92ea0-727a-4cef-9a61-595e2db9c917/2/0
UpLead
B2B company and contact data.
null
Company API
Our Company API lets you lookup company data via a domain name or company name. You get a full overview of the company including size, location, social links, description, and more. For precise results it’s recommended to use a domain name.
401
Missing or invalid UpLead API key
{"error": "Please provide an API key."}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/3cb92ea0-727a-4cef-9a61-595e2db9c917/3/0
UpLead
B2B company and contact data.
null
Company API
Our Company API lets you lookup company data via a domain name or company name. You get a full overview of the company including size, location, social links, description, and more. For precise results it’s recommended to use a domain name.
200
Example success response
{"data": {"address": "410 Terry Ave N", "alexa_rank": 10, "city": "Seattle", "company_name": "Amazon.com, Inc.", "country": "United States", "county": "King", "crunchbase_url": "https://www.crunchbase.com/organization/amazon", "description": "Amazon.com, Inc. offers a range of products and services through its Websites. The Company operates through three segments: North America, International and Amazon Web Services (AWS). The Company's products include merchandise and content that it purchases for resale from vendors and those offered by third-party sellers. It also manufactures and sells electronic devices. The Company, through its subsidiary, Whole Foods Market, Inc., offers healthy and organic food and staples across its stores. The Company also offers a range of products like whole trade bananas, organic avocados, organic large brown eggs, organic responsibly-farmed salmon and tilapia, organic baby kale and baby lettuce, animal-welfare-rated 85% lean ground beef, creamy and crunchy almond butter, organic gala and fuji apples, organic rotisserie chicken.", "domain": "amazon.com", "employees": "Over 10,000", "exchange": "Nasdaq", "facebook_url": "https://www.facebook.com/Amazon", "fax_number": "3026365454", "id": "9c7a4e17-9090-4293-a74b-05b0d0e34516", "industry": "Retail", "instagram_url": "https://www.instagram.com/amazon/", "linkedin_url": "https://www.linkedin.com/company/amazon", "logo": "https://logo.uplead.com/amazon.com", "naics_code": 45411, "naics_description": "Electronic Shopping and Mail-Order Houses", "phone_number": "2062661000", "revenue": "Over $1 Billion", "sic_code": 5961, "sic_description": "Catalog and Mail-Order Houses", "state": "WA", "ticker": "AMZN", "twitter_url": "https://twitter.com/amazon", "type": "Public", "year_founded": 1994, "yelp_url": "", "youtube_url": "https://www.youtube.com/user/amazon", "zip": "98109"}}
{"properties": {"data": {"properties": {"address": {"type": "string"}, "alexa_rank": {"type": "integer"}, "city": {"type": "string"}, "company_name": {"type": "string"}, "country": {"type": "string"}, "county": {"type": "string"}, "crunchbase_url": {"type": "string"}, "description": {"type": "string"}, "domain": {"type": "string"}, "employees": {"type": "string"}, "exchange": {"type": "string"}, "facebook_url": {"type": "string"}, "fax_number": {"type": "string"}, "id": {"type": "string"}, "industry": {"type": "string"}, "instagram_url": {"type": "string"}, "linkedin_url": {"type": "string"}, "logo": {"type": "string"}, "naics_code": {"type": "integer"}, "naics_description": {"type": "string"}, "phone_number": {"type": "string"}, "revenue": {"type": "string"}, "sic_code": {"type": "integer"}, "sic_description": {"type": "string"}, "state": {"type": "string"}, "ticker": {"type": "string"}, "twitter_url": {"type": "string"}, "type": {"type": "string"}, "year_founded": {"type": "integer"}, "yelp_url": {"type": "string"}, "youtube_url": {"type": "string"}, "zip": {"type": "string"}}, "type": ["object", "null"]}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/3cb92ea0-727a-4cef-9a61-595e2db9c917/3/1
UpLead
B2B company and contact data.
null
Company API
Our Company API lets you lookup company data via a domain name or company name. You get a full overview of the company including size, location, social links, description, and more. For precise results it’s recommended to use a domain name.
200
Not found
{"data": null}
{"properties": {"data": {"properties": {"address": {"type": "string"}, "alexa_rank": {"type": "integer"}, "city": {"type": "string"}, "company_name": {"type": "string"}, "country": {"type": "string"}, "county": {"type": "string"}, "crunchbase_url": {"type": "string"}, "description": {"type": "string"}, "domain": {"type": "string"}, "employees": {"type": "string"}, "exchange": {"type": "string"}, "facebook_url": {"type": "string"}, "fax_number": {"type": "string"}, "id": {"type": "string"}, "industry": {"type": "string"}, "instagram_url": {"type": "string"}, "linkedin_url": {"type": "string"}, "logo": {"type": "string"}, "naics_code": {"type": "integer"}, "naics_description": {"type": "string"}, "phone_number": {"type": "string"}, "revenue": {"type": "string"}, "sic_code": {"type": "integer"}, "sic_description": {"type": "string"}, "state": {"type": "string"}, "ticker": {"type": "string"}, "twitter_url": {"type": "string"}, "type": {"type": "string"}, "year_founded": {"type": "integer"}, "yelp_url": {"type": "string"}, "youtube_url": {"type": "string"}, "zip": {"type": "string"}}, "type": ["object", "null"]}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bee86c28-f835-4003-a14e-4561b504a6b0/0/0
UpLead
B2B company and contact data.
null
Person API
Our Person API lets you lookup a person based on an email address OR based on a domain name + first name + last name. You get a full overview of the person including name, location, email, phone number, social links and more.
401
Missing or invalid UpLead API key
{"error": "Please provide an API key."}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bee86c28-f835-4003-a14e-4561b504a6b0/1/0
UpLead
B2B company and contact data.
null
Person API
Our Person API lets you lookup a person based on an email address OR based on a domain name + first name + last name. You get a full overview of the person including name, location, email, phone number, social links and more.
403
Insufficient credits
{"error": "You don't have enough credits"}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bee86c28-f835-4003-a14e-4561b504a6b0/2/0
UpLead
B2B company and contact data.
null
Person API
Our Person API lets you lookup a person based on an email address OR based on a domain name + first name + last name. You get a full overview of the person including name, location, email, phone number, social links and more.
400
Invalid params
{"errors": ["email is required"]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"errors": {"type": "array", "items": {"type": "string"}}}, "required": ["errors"]}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bee86c28-f835-4003-a14e-4561b504a6b0/3/0
UpLead
B2B company and contact data.
null
Person API
Our Person API lets you lookup a person based on an email address OR based on a domain name + first name + last name. You get a full overview of the person including name, location, email, phone number, social links and more.
200
Example success response
{"data": {"city": "San Francisco", "company_name": "Salesforce.com, Inc.", "country": "United States", "domain": "salesforce.com", "email": "[email protected]", "email_status": "valid", "first_name": "marc", "gender": "male", "id": "d98e157e-c31d-40a0-9d98-b2fb8390797d", "industry": "Internet", "job_function": "", "last_name": "benioff", "linkedin_url": "https://www.linkedin.com/in/marcbenioff/", "management_level": "c_level", "phone_number": "4159017000", "state": "CA", "title": "ceo"}}
{"properties": {"data": {"properties": {"city": {"type": "string"}, "company_name": {"type": "string"}, "country": {"type": "string"}, "domain": {"type": "string"}, "email": {"type": "string"}, "email_status": {"type": "string"}, "first_name": {"type": "string"}, "gender": {"type": "string"}, "id": {"type": "string"}, "industry": {"type": "string"}, "job_function": {"type": "string"}, "last_name": {"type": "string"}, "linkedin_url": {"type": "string"}, "management_level": {"type": "string"}, "phone_number": {"type": "string"}, "state": {"type": "string"}, "title": {"type": "string"}}, "type": ["object", "null"]}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bee86c28-f835-4003-a14e-4561b504a6b0/3/1
UpLead
B2B company and contact data.
null
Person API
Our Person API lets you lookup a person based on an email address OR based on a domain name + first name + last name. You get a full overview of the person including name, location, email, phone number, social links and more.
200
Not found
{"data": null}
{"properties": {"data": {"properties": {"city": {"type": "string"}, "company_name": {"type": "string"}, "country": {"type": "string"}, "domain": {"type": "string"}, "email": {"type": "string"}, "email_status": {"type": "string"}, "first_name": {"type": "string"}, "gender": {"type": "string"}, "id": {"type": "string"}, "industry": {"type": "string"}, "job_function": {"type": "string"}, "last_name": {"type": "string"}, "linkedin_url": {"type": "string"}, "management_level": {"type": "string"}, "phone_number": {"type": "string"}, "state": {"type": "string"}, "title": {"type": "string"}}, "type": ["object", "null"]}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/78174c90-c768-4707-8384-49c883994ef5/0/0
UpLead
B2B company and contact data.
null
Credits
This endpoint allows you to get information about your remaining credits.
401
Missing or invalid UpLead API key
{"error": "Please provide an API key."}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/78174c90-c768-4707-8384-49c883994ef5/1/0
UpLead
B2B company and contact data.
null
Credits
This endpoint allows you to get information about your remaining credits.
200
Example success response
{"data": {"credits": 100, "email": "[email protected]"}}
{"properties": {"data": {"properties": {"credits": {"type": "integer"}, "email": {"type": "string"}}, "type": "object"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bd199633-044b-4191-8a5f-e3b9f7597d02/0/0
UpLead
B2B company and contact data.
null
Company Name to Domain API
Our Company Name to Domain API lets you convert the name of a company to its website domain and logo. The match is based on the exact company name and returns the most important company (based on website traffic). Please note because not all company names are unique, there may be some inaccuracy in the results.
400
Invalid params
{"errors": ["company_name is missing"]}
{"properties": {"errors": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bd199633-044b-4191-8a5f-e3b9f7597d02/1/0
UpLead
B2B company and contact data.
null
Company Name to Domain API
Our Company Name to Domain API lets you convert the name of a company to its website domain and logo. The match is based on the exact company name and returns the most important company (based on website traffic). Please note because not all company names are unique, there may be some inaccuracy in the results.
403
Insufficient credits
{"error": "You don't have enough credits"}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bd199633-044b-4191-8a5f-e3b9f7597d02/2/0
UpLead
B2B company and contact data.
null
Company Name to Domain API
Our Company Name to Domain API lets you convert the name of a company to its website domain and logo. The match is based on the exact company name and returns the most important company (based on website traffic). Please note because not all company names are unique, there may be some inaccuracy in the results.
200
Example success response
{"data": {"company_name": "Amazon.com, Inc.", "domain": "amazon.com", "logo": "https://logo.uplead.com/amazon.com"}}
{"properties": {"data": {"properties": {"company_name": {"type": "string"}, "domain": {"type": "string"}, "logo": {"type": "string"}}, "type": ["object", "null"]}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bd199633-044b-4191-8a5f-e3b9f7597d02/2/1
UpLead
B2B company and contact data.
null
Company Name to Domain API
Our Company Name to Domain API lets you convert the name of a company to its website domain and logo. The match is based on the exact company name and returns the most important company (based on website traffic). Please note because not all company names are unique, there may be some inaccuracy in the results.
200
Not found
{"data": null}
{"properties": {"data": {"properties": {"company_name": {"type": "string"}, "domain": {"type": "string"}, "logo": {"type": "string"}}, "type": ["object", "null"]}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/bd199633-044b-4191-8a5f-e3b9f7597d02/3/0
UpLead
B2B company and contact data.
null
Company Name to Domain API
Our Company Name to Domain API lets you convert the name of a company to its website domain and logo. The match is based on the exact company name and returns the most important company (based on website traffic). Please note because not all company names are unique, there may be some inaccuracy in the results.
401
Missing or invalid UpLead API key
{"error": "Please provide an API key."}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/676b3741-c769-45f9-bc4a-ba8c028a9e48/0/0
UpLead
B2B company and contact data.
null
Prospector API
Our Prospector API lets you find contacts and emails associated with a company, job title, job function, management level and location.
401
Missing or invalid UpLead API key
{"error": "Please provide an API key."}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/676b3741-c769-45f9-bc4a-ba8c028a9e48/1/0
UpLead
B2B company and contact data.
null
Prospector API
Our Prospector API lets you find contacts and emails associated with a company, job title, job function, management level and location.
400
Invalid params
{"errors": ["domain is missing"]}
{"properties": {"errors": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/676b3741-c769-45f9-bc4a-ba8c028a9e48/2/0
UpLead
B2B company and contact data.
null
Prospector API
Our Prospector API lets you find contacts and emails associated with a company, job title, job function, management level and location.
403
Insufficient credits
{"error": "You don't have enough credits"}
{"properties": {"error": {"type": "string"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/676b3741-c769-45f9-bc4a-ba8c028a9e48/3/0
UpLead
B2B company and contact data.
null
Prospector API
Our Prospector API lets you find contacts and emails associated with a company, job title, job function, management level and location.
200
Example success response
{"data": {"meta": {"first_page": true, "last_page": false, "next_page": 2, "page": 1, "previous_page": null, "total": 100}, "results": [{"city": "San Francisco", "company_name": "Salesforce.com, Inc.", "country": "United States", "domain": "salesforce.com", "email": "[email protected]", "email_status": "valid", "first_name": "mark", "gender": "male", "id": "5f77c393-111f-4c57-9feb-cb777b02418d", "industry": "Internet", "job_function": "finance", "last_name": "hawkins", "linkedin_url": "https://www.linkedin.com/in/markjhawkins/", "management_level": "c_level", "phone_number": "4159017000", "state": "CA", "title": "president & cfo"}]}}
{"properties": {"data": {"properties": {"meta": {"properties": {"first_page": {"type": "boolean"}, "last_page": {"type": "boolean"}, "next_page": {"type": "integer"}, "page": {"type": "integer"}, "previous_page": {"type": "null"}, "total": {"type": "integer"}}, "type": "object"}, "results": {"items": {"properties": {"city": {"type": "string"}, "company_name": {"type": "string"}, "country": {"type": "string"}, "domain": {"type": "string"}, "email": {"type": "string"}, "email_status": {"type": "string"}, "first_name": {"type": "string"}, "gender": {"type": "string"}, "id": {"type": "string"}, "industry": {"type": "string"}, "job_function": {"type": "string"}, "last_name": {"type": "string"}, "linkedin_url": {"type": "string"}, "management_level": {"type": "string"}, "phone_number": {"type": "string"}, "state": {"type": "string"}, "title": {"type": "string"}}, "type": "object"}, "type": "array"}}, "type": "object"}}, "type": "object"}
8a5e7342-1ad6-4c60-a9cb-9ae9ea542875/676b3741-c769-45f9-bc4a-ba8c028a9e48/3/1
UpLead
B2B company and contact data.
null
Prospector API
Our Prospector API lets you find contacts and emails associated with a company, job title, job function, management level and location.
200
Not found
{"data": {"meta": {}, "results": []}}
{"properties": {"data": {"properties": {"meta": {"properties": {"first_page": {"type": "boolean"}, "last_page": {"type": "boolean"}, "next_page": {"type": "integer"}, "page": {"type": "integer"}, "previous_page": {"type": "null"}, "total": {"type": "integer"}}, "type": "object"}, "results": {"items": {"properties": {"city": {"type": "string"}, "company_name": {"type": "string"}, "country": {"type": "string"}, "domain": {"type": "string"}, "email": {"type": "string"}, "email_status": {"type": "string"}, "first_name": {"type": "string"}, "gender": {"type": "string"}, "id": {"type": "string"}, "industry": {"type": "string"}, "job_function": {"type": "string"}, "last_name": {"type": "string"}, "linkedin_url": {"type": "string"}, "management_level": {"type": "string"}, "phone_number": {"type": "string"}, "state": {"type": "string"}, "title": {"type": "string"}}, "type": "object"}, "type": "array"}}, "type": "object"}}, "type": "object"}
9e5184f1-0a23-4164-826c-e3433681f27a/2d681f5f-f307-4e12-88a2-4d1abc49a5c5/1/0
ESS API
Ebusiness Software Services API
null
extract
200
null
{"successful": true, "result": "", "message": ""}
{"type": "object", "properties": {"successful": {"type": "boolean"}, "result": {"type": "string"}, "message": {"type": "string"}}}
9e5184f1-0a23-4164-826c-e3433681f27a/4de6b4a1-c6ad-48dd-bb97-610b8654f6bf/1/0
ESS API
Ebusiness Software Services API
null
transform
200
null
{"successful": true, "fileDto": {"filename": "", "content": "", "checksum": ""}, "message": "", "mimeType": ""}
{"type": "object", "properties": {"successful": {"type": "boolean"}, "fileDto": {"type": "object", "properties": {"filename": {"type": "string"}, "content": {"type": "string"}, "checksum": {"type": "string"}}}, "message": {"type": "string"}, "mimeType": {"type": "string"}}}
258a2228-c3f3-45c6-84d5-907f9caaec29/f0739b9b-7388-41dc-bab5-12048bb18f65/0/0
PTL
receive user
8
update
update endpoint
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"]}
258a2228-c3f3-45c6-84d5-907f9caaec29/e4442f04-aa38-41b6-8c07-2bb07898af3b/0/0
PTL
receive user
8
create_client
Receive new users
200
New Example
{"messages_good": ["New client created"], "mesages_bad": [], "client": {"client": {"exp_date": null, "created_at": "2022-12-01T20:53:20+01:00", "lastname": "Grozdic", "status": 1, "telephone_mobile": "milos", "firstname": "Milos", "id": 291201, "email": "[email protected]", "updated_at": "2022-12-01T20:53:20+01:00"}}, "success": true}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"messages_good": {"type": "array", "items": {"type": "string"}}, "mesages_bad": {"type": "array"}, "client": {"type": "object", "properties": {"client": {"type": "object", "properties": {"exp_date": {"type": "null"}, "created_at": {"type": "string"}, "lastname": {"type": "string"}, "status": {"type": "integer"}, "telephone_mobile": {"type": "string"}, "firstname": {"type": "string"}, "id": {"type": "integer"}, "email": {"type": "string"}, "updated_at": {"type": "string"}}, "required": ["created_at", "email", "exp_date", "firstname", "id", "lastname", "status", "telephone_mobile", "updated_at"]}}, "required": ["client"]}, "success": {"type": "boolean"}}, "required": ["client", "mesages_bad", "messages_good", "success"]}
cd51a48c-dc01-4252-bf01-9fc16f9f1ea7/9ee1b174-e452-4caa-9db4-39b4003f91d0/0/0
Company
Convert domains into full company profiles.
8.2
Company API Streaming
An alternative to using our async lookup or webhooks is our streaming API. This API is ideal if you don’t mind long lived requests (e.g. you’re making requests to BigPicture from a messaging queue).
200
New Example
{"id": "4eec624c-c1b4-43c5-9a91-c96859353ccc", "name": "Uber Technologies", "legalName": "Uber Technologies, Inc.", "domain": "uber.com", "domainAliases": ["uber-adsystem.com", "decarta.com"], "url": "https://www.uber.com/", "tags": ["Mobile Apps", "Public Transportation", "Ride Sharing", "Transportation"], "category": {"sector": "Technology", "industryGroup": "Technology", "industry": "Software & Computer Services", "subIndustry": "Software"}, "description": "Uber Technologies, Inc. develops and operates proprietary technology applications in the United States, Canada, Latin America, Europe, the Middle East, Africa, and the Asia Pacific. It connects consumers with independent providers of ride services for ridesharing services and other forms of transportation services, including public transit, as well as connect riders and other consumers with restaurants, grocers, other stores, and delivery service providers for meal preparation, grocery, and other delivery services...", "foundedYear": 2009, "location": "1515 3Rd Street San Francisco, CA 94158 United States of America", "geo": {"city": "San Francisco", "state": "California", "country": "United States of America", "stateCode": "CA", "postalCode": "94158", "streetName": "3Rd Street", "subPremise": null, "countryCode": "US", "streetNumber": "1515"}, "metrics": {"alexaUsRank": 680, "alexaGlobalRank": 1153, "employees": 22200, "employeesRange": "10K+", "marketCap": 86561472512, "annualRevenue": 10794000384, "estimatedAnnualRevenue": "$10B+", "raised": 2400000000}, "tech": ["google_analytics", "wordpress"], "facebook": {"handle": "uber"}, "linkedin": {"handle": "company/uber-com"}, "twitter": {"id": "19103481", "bio": "We wear masks to help protect our neighbors, our families, and our communities. Please wear a face cover or mask.\n\nNo mask. No ride.", "site": "http://uber.com", "avatar": "https://pbs.twimg.com/profile_images/1045783102000230400/TPLLaqYR_normal.jpg", "handle": "Uber", "location": "Global", "followers": 1053046, "following": 55}, "crunchbase": {"handle": "organization/uber"}, "logo": "http://logo.bigpicture.io/logo/uber.com", "emailProvider": false, "type": "public", "ticker": "UBER", "phone": "1-415-801-4068"}
{"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "legalName": {"type": "string"}, "domain": {"type": "string"}, "domainAliases": {"type": "array", "items": {"type": "string"}}, "url": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "category": {"type": "object", "properties": {"sector": {"type": "string"}, "industryGroup": {"type": "string"}, "industry": {"type": "string"}, "subIndustry": {"type": "string"}}}, "description": {"type": "string"}, "foundedYear": {"type": "integer"}, "location": {"type": "string"}, "geo": {"type": "object", "properties": {"city": {"type": "string"}, "state": {"type": "string"}, "country": {"type": "string"}, "stateCode": {"type": "string"}, "postalCode": {"type": "string"}, "streetName": {"type": "string"}, "subPremise": {"type": "null"}, "countryCode": {"type": "string"}, "streetNumber": {"type": "string"}}}, "metrics": {"type": "object", "properties": {"alexaUsRank": {"type": "integer"}, "alexaGlobalRank": {"type": "integer"}, "employees": {"type": "integer"}, "employeesRange": {"type": "string"}, "marketCap": {"type": "integer"}, "annualRevenue": {"type": "integer"}, "estimatedAnnualRevenue": {"type": "string"}, "raised": {"type": "integer"}}}, "tech": {"type": "array", "items": {"type": "string"}}, "facebook": {"type": "object", "properties": {"handle": {"type": "string"}}}, "linkedin": {"type": "object", "properties": {"handle": {"type": "string"}}}, "twitter": {"type": "object", "properties": {"id": {"type": "string"}, "bio": {"type": "string"}, "site": {"type": "string"}, "avatar": {"type": "string"}, "handle": {"type": "string"}, "location": {"type": "string"}, "followers": {"type": "integer"}, "following": {"type": "integer"}}}, "crunchbase": {"type": "object", "properties": {"handle": {"type": "string"}}}, "logo": {"type": "string"}, "emailProvider": {"type": "boolean"}, "type": {"type": "string"}, "ticker": {"type": "string"}, "phone": {"type": "string"}}}
cd51a48c-dc01-4252-bf01-9fc16f9f1ea7/9ee1b174-e452-4caa-9db4-39b4003f91d0/1/0
Company
Convert domains into full company profiles.
8.2
Company API Streaming
An alternative to using our async lookup or webhooks is our streaming API. This API is ideal if you don’t mind long lived requests (e.g. you’re making requests to BigPicture from a messaging queue).
404
New Example
{"error": {"type": "not_found", "message": "The record was not found."}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"error": {"type": "object", "properties": {"type": {"type": "string"}, "message": {"type": "string"}}, "required": ["message", "type"]}}, "required": ["error"]}
cd51a48c-dc01-4252-bf01-9fc16f9f1ea7/0ab956c4-6404-4994-a969-a3babfe2671d/0/0
Company
Convert domains into full company profiles.
8.2
Company API
The Company API enables you to lookup company data based on a domain name. This can be used to retrieve the company's information such as name, address, industry, headcount, and various other details from their domain name.
429
New Example
{"error": {"type": "rate_limit", "message": "Too many requests made to the API too quickly."}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"error": {"type": "object", "properties": {"type": {"type": "string"}, "message": {"type": "string"}}, "required": ["message", "type"]}}, "required": ["error"]}
cd51a48c-dc01-4252-bf01-9fc16f9f1ea7/0ab956c4-6404-4994-a969-a3babfe2671d/1/0
Company
Convert domains into full company profiles.
8.2
Company API
The Company API enables you to lookup company data based on a domain name. This can be used to retrieve the company's information such as name, address, industry, headcount, and various other details from their domain name.
404
New Example
{"error": {"type": "not_found", "message": "The record was not found."}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"error": {"type": "object", "properties": {"type": {"type": "string"}, "message": {"type": "string"}}, "required": ["message", "type"]}}, "required": ["error"]}
cd51a48c-dc01-4252-bf01-9fc16f9f1ea7/0ab956c4-6404-4994-a969-a3babfe2671d/2/0
Company
Convert domains into full company profiles.
8.2
Company API
The Company API enables you to lookup company data based on a domain name. This can be used to retrieve the company's information such as name, address, industry, headcount, and various other details from their domain name.
200
New Example
{"id": "4eec624c-c1b4-43c5-9a91-c96859353ccc", "name": "Uber Technologies", "legalName": "Uber Technologies, Inc.", "domain": "uber.com", "domainAliases": ["uber-adsystem.com", "decarta.com"], "url": "https://www.uber.com/", "tags": ["Mobile Apps", "Public Transportation", "Ride Sharing", "Transportation"], "category": {"sector": "Technology", "industryGroup": "Technology", "industry": "Software & Computer Services", "subIndustry": "Software"}, "description": "Uber Technologies, Inc. develops and operates proprietary technology applications in the United States, Canada, Latin America, Europe, the Middle East, Africa, and the Asia Pacific. It connects consumers with independent providers of ride services for ridesharing services and other forms of transportation services, including public transit, as well as connect riders and other consumers with restaurants, grocers, other stores, and delivery service providers for meal preparation, grocery, and other delivery services...", "foundedYear": 2009, "location": "1515 3Rd Street San Francisco, CA 94158 United States of America", "geo": {"city": "San Francisco", "state": "California", "country": "United States of America", "stateCode": "CA", "postalCode": "94158", "streetName": "3Rd Street", "subPremise": null, "countryCode": "US", "streetNumber": "1515"}, "metrics": {"alexaUsRank": 680, "alexaGlobalRank": 1153, "employees": 22200, "employeesRange": "10K+", "marketCap": 86561472512, "annualRevenue": 10794000384, "estimatedAnnualRevenue": "$10B+", "raised": 2400000000}, "tech": ["google_analytics", "wordpress"], "facebook": {"handle": "uber"}, "linkedin": {"handle": "company/uber-com"}, "twitter": {"id": "19103481", "bio": "We wear masks to help protect our neighbors, our families, and our communities. Please wear a face cover or mask.\n\nNo mask. No ride.", "site": "http://uber.com", "avatar": "https://pbs.twimg.com/profile_images/1045783102000230400/TPLLaqYR_normal.jpg", "handle": "Uber", "location": "Global", "followers": 1053046, "following": 55}, "crunchbase": {"handle": "organization/uber"}, "logo": "http://logo.bigpicture.io/logo/uber.com", "emailProvider": false, "type": "public", "ticker": "UBER", "phone": "1-415-801-4068"}
{"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "legalName": {"type": "string"}, "domain": {"type": "string"}, "domainAliases": {"type": "array", "items": {"type": "string"}}, "url": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "category": {"type": "object", "properties": {"sector": {"type": "string"}, "industryGroup": {"type": "string"}, "industry": {"type": "string"}, "subIndustry": {"type": "string"}}}, "description": {"type": "string"}, "foundedYear": {"type": "integer"}, "location": {"type": "string"}, "geo": {"type": "object", "properties": {"city": {"type": "string"}, "state": {"type": "string"}, "country": {"type": "string"}, "stateCode": {"type": "string"}, "postalCode": {"type": "string"}, "streetName": {"type": "string"}, "subPremise": {"type": "null"}, "countryCode": {"type": "string"}, "streetNumber": {"type": "string"}}}, "metrics": {"type": "object", "properties": {"alexaUsRank": {"type": "integer"}, "alexaGlobalRank": {"type": "integer"}, "employees": {"type": "integer"}, "employeesRange": {"type": "string"}, "marketCap": {"type": "integer"}, "annualRevenue": {"type": "integer"}, "estimatedAnnualRevenue": {"type": "string"}, "raised": {"type": "integer"}}}, "tech": {"type": "array", "items": {"type": "string"}}, "facebook": {"type": "object", "properties": {"handle": {"type": "string"}}}, "linkedin": {"type": "object", "properties": {"handle": {"type": "string"}}}, "twitter": {"type": "object", "properties": {"id": {"type": "string"}, "bio": {"type": "string"}, "site": {"type": "string"}, "avatar": {"type": "string"}, "handle": {"type": "string"}, "location": {"type": "string"}, "followers": {"type": "integer"}, "following": {"type": "integer"}}}, "crunchbase": {"type": "object", "properties": {"handle": {"type": "string"}}}, "logo": {"type": "string"}, "emailProvider": {"type": "boolean"}, "type": {"type": "string"}, "ticker": {"type": "string"}, "phone": {"type": "string"}}}
cd51a48c-dc01-4252-bf01-9fc16f9f1ea7/0ab956c4-6404-4994-a969-a3babfe2671d/3/0
Company
Convert domains into full company profiles.
8.2
Company API
The Company API enables you to lookup company data based on a domain name. This can be used to retrieve the company's information such as name, address, industry, headcount, and various other details from their domain name.
400
New Example
{"error": {"type": "bad_request", "message": "Bad Request"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"error": {"type": "object", "properties": {"type": {"type": "string"}, "message": {"type": "string"}}, "required": ["message", "type"]}}, "required": ["error"]}
cd51a48c-dc01-4252-bf01-9fc16f9f1ea7/0ab956c4-6404-4994-a969-a3babfe2671d/4/0
Company
Convert domains into full company profiles.
8.2
Company API
The Company API enables you to lookup company data based on a domain name. This can be used to retrieve the company's information such as name, address, industry, headcount, and various other details from their domain name.
202
New Example
{"type": "async_created", "message": "Your request has been received and is being processed."}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"type": {"type": "string"}, "message": {"type": "string"}}, "required": ["message", "type"]}
900ce1b3-90a1-48cf-8d53-d2cc1044f649/145c8df7-1208-4c49-b60c-dfc83d38d4bb/0/0
APITemplate
APITemplate.io allows you to auto-generate images and PDF documents from reusable templates with a simple API.
0
list-objects
Retrieves all the generated PDFs and images
200
null
{"status": "success", "objects": []}
{"type": "object", "properties": {"status": {"type": "string"}, "objects": {"type": "array"}}}
900ce1b3-90a1-48cf-8d53-d2cc1044f649/ad991ad9-1955-4a07-b11a-35464a65c59f/0/0
APITemplate
APITemplate.io allows you to auto-generate images and PDF documents from reusable templates with a simple API.
0
create-image
This endpoint creates a JPEG file(along with PNG) with JSON data and your template
200
null
{"status": "success", "download_url": "https://bucket.s3.amazonaws.com/91f62769-69e4-48bf.jpeg", "download_url_png": "https://bucket.s3.amazonaws.com/91f62769-69e4-48bf.png", "template_id": "cd890b2b199c5c42", "transaction_ref": "a0430897-2c94-40e1-a09b-57403d811ceb"}
{"type": "object", "properties": {"status": {"type": "string", "description": "Status"}, "download_url": {"type": "string", "description": "Download URL"}, "download_url_png": {"type": "string", "description": "Download URL PNG"}, "template_id": {"type": "string", "description": "Template ID"}, "transaction_ref": {"type": "string", "description": "Transaction reference"}}}
900ce1b3-90a1-48cf-8d53-d2cc1044f649/6c669200-658b-4943-a9f7-8350aeecf816/0/0
APITemplate
APITemplate.io allows you to auto-generate images and PDF documents from reusable templates with a simple API.
0
delete-object
Delete a PDF or an image from CDN and mark the transaction as deleted
200
null
{"status": "success"}
{"type": "object", "properties": {"status": {"type": "string"}, "transaction_ref": {}}}
900ce1b3-90a1-48cf-8d53-d2cc1044f649/7af60bd6-a306-4d72-8ccb-f1636dd83b60/0/0
APITemplate
APITemplate.io allows you to auto-generate images and PDF documents from reusable templates with a simple API.
0
list-templates
Retrieves the information of templates
200
null
{"status": "success", "templates": []}
{"type": "object", "properties": {"status": {"type": "string"}, "templates": {"type": "array"}}}
900ce1b3-90a1-48cf-8d53-d2cc1044f649/e7c005d7-b6e9-48d0-9b79-873fe08b5120/0/0
APITemplate
APITemplate.io allows you to auto-generate images and PDF documents from reusable templates with a simple API.
0
create-pdf
This endpoint creates a PDF file with JSON data and your template. We support synchoronus and asynchronous PDF generation.
200
null
{"status": "success", "download_url": "https://bucket.s3.amazonaws.com/91f62769-69e4-48bf.jpeg", "template_id": "cd890b2b199c5c42", "transaction_ref": "a0430897-2c94-40e1-a09b-57403d811ceb"}
{"type": "object", "properties": {"status": {"type": "string", "description": "Status"}, "download_url": {"type": "string", "description": "Download URL"}, "template_id": {"type": "string", "description": "Template ID"}, "transaction_ref": {"type": "string", "description": "Transaction reference"}}}
900ce1b3-90a1-48cf-8d53-d2cc1044f649/344e4ccf-c6bf-43c0-a16c-cc3c819d4a93/0/0
APITemplate
APITemplate.io allows you to auto-generate images and PDF documents from reusable templates with a simple API.
0
merge-pdfs
This endpoint merges multiple PDF URLs
200
null
{"status": "success", "primary_url": "https://craftmypdf.com/output.pdf", "transaction_ref": "a0430897-2c94-40e1-a09b-57403d811ceb"}
{"type": "object", "properties": {"status": {"type": "string", "description": "Status"}, "primary_url": {"type": "string", "description": "Generated PDF document"}, "transaction_ref": {"type": "string", "description": "Transaction reference"}}}
1e9731ff-f05a-46e0-9b9f-d45e4628e619/951ce8e0-5b69-45f9-9d8c-0c2f4159e2be/0/0
LimouCloud
LimouCloud APIs
0.2
Confirm Verification Code
Please send verification code in post request to confirm
403
New Example
{"success": false, "message": "Incorrect Code!", "errors": {"code": ["Incorrect Code!"]}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}, "errors": {"type": "object", "properties": {"code": {"type": "array", "items": {"type": "string"}}}, "required": ["code"]}}, "required": ["errors", "message", "success"]}