Datasets:
davidfant
/
rapidapi-example-responses

Dataset card Data Studio Files Community
1
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
fecd2438-8469-4d33-b9d2-911466bfae16/005fc14b-f716-44af-a204-373a6c34232d/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-user
Get a particular user profile.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/005fc14b-f716-44af-a204-373a6c34232d/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-user
Get a particular user profile.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "tenant-17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {"property1": "string", "property2": "string"}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["upwork"]}}
{"title": "User Get Response", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "User", "type": "object", "description": "A user is someone who is authorizing Smile to retrieve and share their employment and income data on their behalf.", "x-tags": ["Users"], "x-examples": {"Example": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {"property1": "string", "property2": "string"}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["upwork"]}}, "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "externalMetadata": {"title": "Object-ExternalMetadata", "type": "object", "additionalProperties": {"type": "string"}, "maxProperties": 5, "description": "The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:\n- The JSON values must be Strings (no nested JSON objects allowed)\n- Only ASCII characters can be used\n- Maximum of 5 key/value pairs\n- Maximum key length of 50 characters\n- Maximum value length of 500 characters", "x-internal": true}, "createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "providers": {"description": "Array of providers connected to this user (listed by provider ID)", "type": "array", "items": {"type": "string"}}}, "required": ["id", "externalMetadata", "createdAt", "providers"]}}, "x-internal": true, "x-examples": {}}
fecd2438-8469-4d33-b9d2-911466bfae16/005fc14b-f716-44af-a204-373a6c34232d/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-user
Get a particular user profile.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/005fc14b-f716-44af-a204-373a6c34232d/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-user
Get a particular user profile.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/005fc14b-f716-44af-a204-373a6c34232d/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-user
Get a particular user profile.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "fullName": "George Cimafranca Palomero, Jr", "firstName": "George", "lastName": "Palomero", "email": "[email protected]", "templateId": "tpl-b2c5e816-65ad-4130-819d-db89acc5869a", "winkTemplateId": "wtpl-db89acc5869a-b2c5e816-65ad-4130-819d", "userId": "tenantId-b2c5e816-65ad-4130-819d-db89acc5869a", "status": "INVITED", "updatedAt": "2021-04-14T09:30:24Z", "invitedAt": "2021-04-14T09:30:24Z", "linkedAt": "2021-04-14T09:30:24Z"}}
{"title": "InviteGetResponse", "type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "Invite", "type": "object", "description": "Invitation for a user to share their data.", "x-tags": ["Invites"], "x-examples": {"Example": {"id": "inv-b2c5e816-65ad-4130-819d-db89acc5869a", "createdAt": "2021-04-14T09:30:24Z", "fullName": "George Cimafranca Palomero, Jr", "firstName": "George", "lastName": "Palomero", "email": "[email protected]", "templateId": "tpl-b2c5e816-65ad-4130-819d-db89acc5869a", "winkTemplateId": "wtpl-db89acc5869a-b2c5e816-65ad-4130-819d", "userId": "tenant-17bbf36498de4d68a0d4f86c7b62f69f", "status": "INVITED", "updatedAt": "2021-04-14T09:30:24Z", "invitedAt": "2021-04-14T09:30:24Z", "linkedAt": "2021-04-14T09:30:24Z"}}, "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "fullName": {"type": "string", "description": "The full name of the invited user"}, "firstName": {"type": "string", "description": "The first name of the invited user"}, "lastName": {"type": "string", "description": "The last name of the invited user"}, "email": {"description": "The email address of the invited user", "format": "email", "type": "string"}, "templateId": {"type": "string", "description": "The template ID used in the invitation"}, "winkTemplateId": {"type": "string", "description": "The Wink template ID used in the invitation"}, "userId": {"type": "string", "description": "The user ID for this invitation"}, "status": {"type": "string", "enum": ["INVITED", "LINKED"], "description": "Status of the invite"}, "updatedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "invitedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "linkedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}}, "required": ["id", "createdAt", "fullName", "email", "templateId", "userId", "status", "updatedAt", "invitedAt", "linkedAt"]}}, "x-internal": true}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/daad467b-13ad-41fa-acc0-6b7e7a57b4f4/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite
Get invite sent to users by ID.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "i-17bbf36498de4d68a0d4f86c7b62f69f", "fullName": "George Cimafranca Palomero, Jr", "firstName": "George", "middleName": "Cimafranca", "lastName": "Palomero", "suffix": "Jr", "gender": "Male", "dob": "1970-08-24", "maritalStatus": "Married", "countryResidence": "PH", "citizenship": "Citizen", "photoUrl": "https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg", "referenceId": "george", "profileUrl": "https://upwork.com/profiles/george.jpg", "emails": [{"address": "[email protected]", "type": "Primary"}], "phones": [{"number": "+639175551234", "type": "Mobile"}], "socialProfiles": [{"socialUrl": "https://www.facebook.com/gpalomero", "type": "Facebook"}], "addresses": [{"fullAddress": "12 Maybunga St, Barangay Paraiso, Pasig City, NCR, 1600, PH", "line1": "12 Maybunga St", "line2": "Barangay Paraiso", "city": "Pasig City", "region": "NCR", "zip": "1600", "country": "PH", "latitude": "14.573454", "longitude": "121.085042", "type": "Primary"}], "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}}
{"title": "Identity Get Response", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object", "title": "Identity", "description": "The stored identity information of the user from an employment data provider.", "x-examples": {"Example": {"id": "i-17bbf36498de4d68a0d4f86c7b62f69f", "fullName": "George Cimafranca Palomero, Jr", "firstName": "George", "middleName": "Cimafranca", "lastName": "Palomero", "suffix": "Jr", "gender": "Male", "dob": "1970-08-24", "maritalStatus": "Married", "countryResidence": "PH", "citizenship": "Citizen", "photoUrl": "https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg", "referenceId": null, "profileUrl": null, "emails": [{"address": "[email protected]", "type": "Primary"}], "phones": [{"number": "+639559991234", "type": "Mobile"}], "socialProfiles": [{"socialUrl": "https://www.facebook.com/gpalomero", "type": "Facebook"}], "addresses": [{"fullAddress": "12 Maybunga St, Barangay Paraiso, Pasig City, NCR, 1600, PH", "line1": "12 Maybunga St", "line2": "Barangay Paraiso", "city": "Pasig City", "region": "NCR", "zip": "1600", "country": "PH", "latitude": "14.573454", "longitude": "121.085042", "type": "Primary"}], "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}}, "x-tags": ["Identities"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "fullName": {"type": "string", "description": "Full name"}, "firstName": {"type": ["string", "null"], "description": "First name"}, "middleName": {"type": ["string", "null"], "description": "Middle name"}, "lastName": {"type": ["string", "null"], "description": "Last name"}, "suffix": {"type": ["string", "null"], "description": "Suffix"}, "gender": {"type": ["string", "null"], "enum": ["Male", "Female", "Non-binary", null, null], "description": "Gender"}, "dob": {"type": ["string", "null"], "format": "date", "description": "Date of birth"}, "maritalStatus": {"type": ["string", "null"], "enum": ["Divorced", "Married", "Separated", "Single", "Widowed", "Lifetime Partner", null, null], "description": "Marital status"}, "countryResidence": {"type": ["string", "null"], "title": "Country ISO Codes", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RS", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "CS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "XT", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", null, null], "description": "2 character alpha ISO-3166 codes", "x-internal": true}, "citizenship": {"type": ["string", "null"], "enum": ["Citizen", "Resident Alien", "Non-resident Alien", "Undocumented", "Others", null], "description": "Citizenship"}, "photoUrl": {"type": ["string", "null"], "description": "URL to photo or avatar"}, "referenceId": {"type": ["string", "null"], "description": "Reference profile ID from the data provider"}, "profileUrl": {"type": ["string", "null"], "description": "Public profile URL"}, "emails": {"type": "array", "description": "A collection of email addresses", "items": {"type": "object", "title": "email", "properties": {"address": {"type": ["string", "null"], "format": "email", "description": "Email address"}, "type": {"type": ["string", "null"], "title": "Contact Types", "enum": ["Primary", "Secondary", "Work", "Personal", null, null], "description": "Primary contact, with secondary marked as either 'Work' or 'Personal'", "x-internal": true}}, "required": ["address", "type"]}}, "phones": {"type": "array", "description": "A collection of phone numbers", "items": {"type": "object", "title": "phone", "properties": {"number": {"type": ["string", "null"], "title": "International Phone Number", "pattern": "^\\+[1-9]\\d{1,14}$", "description": "Phone numbers in international E.164 format", "x-internal": true}, "type": {"type": ["string", "null"], "title": "Ref-Phone-Type", "enum": ["Mobile", "Fixed", "Unspecified", null, null], "description": "Phone type", "x-internal": true}}, "required": ["number", "type"]}}, "socialProfiles": {"type": "array", "description": "A collection of social media URLs", "items": {"type": "object", "title": "socialProfile", "properties": {"socialUrl": {"type": ["string", "null"], "description": "URL to social media page"}, "type": {"type": ["string", "null"], "enum": ["Twitter", "Facebook", "LinkedIn", "Others", null], "description": "Social media type"}}, "required": ["socialUrl", "type"]}}, "addresses": {"type": "array", "items": {"title": "Address Object", "type": "object", "description": "Address object", "x-internal": true, "properties": {"fullAddress": {"type": ["string", "null"], "description": "Full address"}, "line1": {"type": ["string", "null"], "description": "Line 1 of street address"}, "line2": {"type": ["string", "null"], "description": "Line 2 of street address"}, "city": {"type": ["string", "null"], "description": "City"}, "region": {"type": ["string", "null"], "description": "Geographic region such as state or province"}, "zip": {"type": ["string", "null"], "description": "Post code"}, "country": {"type": ["string", "null"], "title": "Country ISO Codes", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RS", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "CS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "XT", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", null, null], "description": "2 character alpha ISO-3166 codes", "x-internal": true}, "latitude": {"type": ["string", "null"], "pattern": "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$", "description": "Latitude coordinates"}, "longitude": {"type": ["string", "null"], "pattern": "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$", "description": "Longitude coordinates"}, "type": {"type": ["string", "null"], "enum": ["Primary", "Secondary", null, null], "description": "Whether address is primary or secondary"}}, "required": ["type"]}}, "metadata": {"title": "Reference Metadata", "type": "object", "description": "Metadata related to account-specific data", "x-internal": true, "properties": {"createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "accountId": {"type": "string", "description": "The accountId of this object"}, "sourceId": {"type": "string", "description": "The ACCOUNT or ARCHIVE ID associated with this object"}, "sourceType": {"type": "string", "enum": ["ACCOUNT", "UPLOAD", "ARCHIVE"], "description": "Indicates whether the source associated with this object is either ACCOUNT or ARCHIVE type"}, "userId": {"type": "string", "description": "The user ID associated with this object"}, "providerId": {"type": "string", "description": "The provider ID associated with this object"}}, "required": ["createdAt", "sourceId", "sourceType", "userId", "providerId"]}}, "required": ["id", "fullName", "emails", "phones", "socialProfiles", "addresses", "metadata"]}}, "x-internal": true, "x-examples": {}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/aa40934a-c17d-4dc1-be8e-c91fd4e35051/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-identity
Get the user's identity profile by ID.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"id": "upwork", "name": "Upwork", "longName": "Upwork Global Inc.", "logoUrl": "https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png", "type": "GIG", "typeLabel": "Gig Platform", "subType": "SERVICES", "subTypeLabel": "Professional Services", "active": true, "enabled": true, "mfa": true, "accountConnection": true, "supported": ["IDENTITIES"]}, {"id": "freelancer", "name": "Freelancer", "longName": "Freelancer Technology Pty Limited", "logoUrl": "https://cdn.smileapi.io/image/provider-logo/v20210813064500/freelancer.png", "type": "GIG", "typeLabel": "Gig Platform", "subType": "SERVICES", "subTypeLabel": "Professional Services", "active": true, "enabled": true, "mfa": true, "accountConnection": true, "supported": ["IDENTITIES"]}, {"id": "grab", "name": "Grab", "longName": "Grab Holdings Inc", "logoUrl": "https://cdn.smileapi.io/image/provider-logo/v20210813064500/freelancer.png", "type": "GIG", "typeLabel": "Gig Platform", "subType": "TRANSPORTATION", "subTypeLabel": "Transport and Delivery", "active": true, "enabled": true, "mfa": true, "accountConnection": true, "supported": ["IDENTITIES"]}]}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object", "properties": {"nextCursor": {"title": "Object-Next-Cursor", "type": "string", "description": "The next cursor value that can be used in the following query.", "x-internal": false}, "items": {"type": "array", "items": {"title": "Provider", "type": "object", "description": "An employment data provider. A provider holds employment and income information of the user.", "x-tags": ["Providers"], "x-examples": {"Example": {"id": "upwork", "name": "Upwork", "longName": "Upwork Global Inc.", "logoUrl": "https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png", "type": "GIG", "typeLabel": "Gig Platform", "subType": "SERVICES", "subTypeLabel": "Professional Services", "active": true, "enabled": true, "mfa": true, "accountConnection": true, "supported": ["IDENTITIES", "TRANSACTIONS"]}}, "properties": {"id": {"type": "string", "description": "Unique ID of the data provider"}, "name": {"type": "string", "description": "Name of the data provider"}, "longName": {"type": "string", "description": "Full name or legal name of the data provider"}, "logoUrl": {"type": "string", "description": "URL to the data provider's logo"}, "type": {"type": "string", "enum": ["GIG", "GOVERNMENT", "SYSTEM", "EMPLOYER"], "description": "Type of employment data provider"}, "typeLabel": {"type": "string", "description": "Type label of employment data provider, like \"Gig Platform\"", "enum": ["Gig Platform", "Govt Service", "System", "Employer"]}, "subType": {"type": "string", "description": "Subset of Type of employment data provider", "enum": ["SERVICES", "TRANSPORTATION", "SHARING", "TRADING", "INSURANCE", "HRIS", "PAYROLL", "ISIC-A", "ISIC-B", "ISIC-C", "ISIC-D", "ISIC-E", "ISIC-F", "ISIC-G", "ISIC-H", "ISIC-I", "ISIC-J", "ISIC-K", "ISIC-L", "ISIC-M", "ISIC-N", "ISIC-O", "ISIC-P", "ISIC-Q", "ISIC-R", "ISIC-S", "ISIC-T", "ISIC-U"]}, "subTypeLabel": {"type": "string", "description": "Subtype label of employment data provider, like \"Services\"", "enum": ["Professional Services", "Transport and Delivery", "Asset Sharing", "Online Selling", "Social Insurance", "Payroll System", "Human Resource Information System", "Agriculture, forestry and fishing", "Mining and quarrying", "Manufacturing", "Electricity, gas, steam and air conditioning supply", "Water supply; sewerage, waste management and remediation activities", "Construction", "Wholesale and retail trade; repair of motor vehicles and motorcycles", "Transportation and storage", "Accommodation and food service activities", "Information and communication", "Financial and insurance activities", "Real estate activities", "Professional, scientific and technical activities", "Administrative and support service activities", "Public administration and defense; compulsory social security", "Education", "Human health and social work activities", "Arts, entertainment and recreation", "Other service activities", "Activities of households as employers; undifferentiated goods; and services-producing activities of households for own use", "Activities of extraterritorial organization and bodies"]}, "active": {"type": "boolean", "description": "Indicates whether data provider integration is working"}, "enabled": {"type": "boolean", "description": "Indicates whether data provider is enabled or access is allowed for the client"}, "mfa": {"type": "boolean", "description": "Whether data provider requires multi-factor authentication."}, "accountConnection": {"type": "boolean", "description": "Whether a real-time account connection is available for this data provider", "default": true}, "supported": {"type": "array", "description": "Supported data points for this employment data provider", "items": {"type": "string", "enum": ["IDENTITIES", "TRANSACTIONS", "RATINGS", "EMPLOYMENTS", "DOCUMENTS", "INCOMES", "CONTRIBUTIONS"]}}}, "required": ["id", "name", "longName", "logoUrl", "type", "typeLabel", "subType", "subTypeLabel", "active", "enabled", "mfa", "accountConnection", "supported"]}}}}}, "x-internal": true, "x-examples": {}, "title": "Provider List Response", "description": ""}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bd19b948-28b5-4cfd-b019-e61680f71383/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-providers
Get a list of employment data providers from the Smile Network.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"id": "e-17bbf36498de4d68a0d4f86c7b62f69f", "name": "Digital Marketing", "description": "Gathering and reporting relevant data, maintaining specific reports and dashboards, using platforms and programs to address marketing requirements, and updating specific marketing materials.", "jobTitle": "Digital Marketing Assistant", "department": "Marketing", "employeeNumber": "EMP-123456", "employer": "ABC Corporation", "status": "Permanent", "startDate": "2016-02-24", "endDate": "2019-08-24", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "abccorp"}}, {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "name": "Executive Assistant", "description": "Contribute to the efficiency of the business by providing personalized and timely support to executive members particularly the CEO. Responsibilities include managing calendars, making travel arrangements and preparing expense reports.", "jobTitle": "EA to the CEO", "department": "Administation", "employeeNumber": "CDE-98765", "employer": "CDE Corporation", "status": "Permanent", "startDate": "2015-06-14", "endDate": "2016-01-30", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "abccorp"}}]}}
{"title": "Employment List Response", "type": "object", "x-internal": true, "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object", "properties": {"nextCursor": {"title": "Object-Next-Cursor", "type": "string", "description": "The next cursor value that can be used in the following query.", "x-internal": false}, "items": {"type": "array", "items": {"title": "Employment", "type": "object", "x-internal": false, "description": "The stored employment information of the user from an employment data provider.", "x-examples": {"Example": {"id": "e-17bbf36498de4d68a0d4f86c7b62f69f", "name": "Digital Marketing", "description": "Gathering and reporting relevant data, maintaining specific reports and dashboards, using platforms and programs to address marketing requirements, and updating specific marketing materials.", "jobTitle": "Digital Marketing Assistant", "department": "Marketing", "employeeNumber": "EMP-123456", "employer": "ABC Corporation", "status": "Permanent", "startDate": "2016-02-24", "endDate": "2019-08-24", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "abccorp"}}}, "x-tags": ["Employments"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "name": {"type": ["string", "null"], "description": "Work performed"}, "description": {"type": ["string", "null"], "description": "Description of work performed"}, "jobTitle": {"type": ["string", "null"], "description": "Job title"}, "department": {"type": ["string", "null"], "description": "Department or organization in place of employment"}, "employeeNumber": {"type": ["string", "null"], "description": "Employee number in the employment data provider"}, "employer": {"type": ["string", "null"], "title": "Employer", "x-internal": true, "description": "Employer name"}, "status": {"type": ["string", "null"], "description": "Status of employment"}, "startDate": {"type": "string", "description": "Start date", "format": "date"}, "endDate": {"type": ["string", "null"], "description": "End date", "format": "date"}, "metadata": {"title": "Reference Metadata", "type": "object", "description": "Metadata related to account-specific data", "x-internal": true, "properties": {"createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "accountId": {"type": "string", "description": "The accountId of this object"}, "sourceId": {"type": "string", "description": "The ACCOUNT or ARCHIVE ID associated with this object"}, "sourceType": {"type": "string", "enum": ["ACCOUNT", "UPLOAD", "ARCHIVE"], "description": "Indicates whether the source associated with this object is either ACCOUNT or ARCHIVE type"}, "userId": {"type": "string", "description": "The user ID associated with this object"}, "providerId": {"type": "string", "description": "The provider ID associated with this object"}}, "required": ["createdAt", "sourceId", "sourceType", "userId", "providerId"]}}, "required": ["id", "startDate", "metadata"]}}}}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/022a5690-1a77-4b4b-b9de-a307ef98c7a8/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-employments
Get the user's previous employments.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d"}
{"title": "WebhookDeleteResponse", "type": "object", "x-internal": true, "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}}, "x-examples": {}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/9171c180-4c8b-4c0b-86bf-e2e1255b60bb/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
delete-webhook
Delete a webhook endpoint.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"id": "17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "name": "Event Notification Postback", "url": "https://webhook.clienturl.xyz", "eventTypes": ["ACCOUNT_CONNECTED"], "active": true, "secret": "a little secret", "updatedAt": "2021-04-14T09:30:24Z"}]}}
{"title": "WebhookListResponse", "type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object", "properties": {"nextCursor": {"title": "Object-Next-Cursor", "type": "string", "description": "The next cursor value that can be used in the following query.", "x-internal": false}, "items": {"type": "array", "items": {"title": "Webhook", "type": "object", "description": "Receive event notifications via Webhooks.", "x-examples": {"Example": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "name": "Event Notification Postback", "url": "https://webhook.clienturl.xyz", "eventTypes": ["USER_CREATED"], "active": true, "secret": "a little secret", "updatedAt": "2021-04-14T09:30:24Z"}}, "x-internal": true, "x-tags": ["Webhooks"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "name": {"type": "string", "description": "Name of the webhook endpoint"}, "url": {"type": "string", "description": "URL of webhook, must begin with https://"}, "secret": {"type": "string", "description": "The key that will be used to generate HMAC-SHA512 hex digest value in the SmileAPI-Signature header."}, "eventTypes": {"type": "array", "items": {"title": "Ref-WebhookEventType", "description": "Event Type which will be sent as a notification via webhook", "type": "string", "enum": ["USER_CREATED", "ACCOUNT_CONNECTED", "ACCOUNT_DISCONNECTED", "ACCOUNT_FAILED", "ARCHIVE_STARTED", "ARCHIVE_ANALYZED", "ARCHIVE_REVOKED", "ARCHIVE_FAILED", "INVITE_INVITED", "INVITE_LINKED", "IDENTITY_ADDED", "RATING_ADDED", "TRANSACTIONS_ADDED", "DOCUMENTS_ADDED", "EMPLOYMENTS_ADDED", "INCOMES_ADDED", "CONTRIBUTIONS_ADDED", "ALL_EVENTS"]}}, "active": {"type": "boolean", "default": true}, "updatedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}}, "required": ["id", "createdAt", "name", "url", "eventTypes", "active", "updatedAt"]}}}}}, "x-internal": true}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/eab32c99-b068-46f3-945a-4150eee7e9e4/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-webhooks
List all webhook endpoints.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
201
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "fullName": "George Cimafranca Palomero, Jr", "firstName": "George", "lastName": "Palomero", "email": "[email protected]", "templateId": "tpl-b2c5e816-65ad-4130-819d-db89acc5869a", "winkTemplateId": "wtpl-db89acc5869a-b2c5e816-65ad-4130-819d", "userId": "tenantId-b2c5e816-65ad-4130-819d-db89acc5869a", "status": "INVITED", "updatedAt": "2021-04-14T09:30:24Z", "invitedAt": "2021-04-14T09:30:24Z", "linkedAt": "2021-04-14T09:30:24Z"}}
{"title": "InvitePostResponse", "type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "Invite", "type": "object", "description": "Invitation for a user to share their data.", "x-tags": ["Invites"], "x-examples": {"Example": {"id": "inv-b2c5e816-65ad-4130-819d-db89acc5869a", "createdAt": "2021-04-14T09:30:24Z", "fullName": "George Cimafranca Palomero, Jr", "firstName": "George", "lastName": "Palomero", "email": "[email protected]", "templateId": "tpl-b2c5e816-65ad-4130-819d-db89acc5869a", "winkTemplateId": "wtpl-db89acc5869a-b2c5e816-65ad-4130-819d", "userId": "tenant-17bbf36498de4d68a0d4f86c7b62f69f", "status": "INVITED", "updatedAt": "2021-04-14T09:30:24Z", "invitedAt": "2021-04-14T09:30:24Z", "linkedAt": "2021-04-14T09:30:24Z"}}, "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "fullName": {"type": "string", "description": "The full name of the invited user"}, "firstName": {"type": "string", "description": "The first name of the invited user"}, "lastName": {"type": "string", "description": "The last name of the invited user"}, "email": {"description": "The email address of the invited user", "format": "email", "type": "string"}, "templateId": {"type": "string", "description": "The template ID used in the invitation"}, "winkTemplateId": {"type": "string", "description": "The Wink template ID used in the invitation"}, "userId": {"type": "string", "description": "The user ID for this invitation"}, "status": {"type": "string", "enum": ["INVITED", "LINKED"], "description": "Status of the invite"}, "updatedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "invitedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "linkedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}}, "required": ["id", "createdAt", "fullName", "email", "templateId", "userId", "status", "updatedAt", "invitedAt", "linkedAt"]}}, "x-examples": {}, "x-internal": true}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/37a54f57-c2d3-41d6-b71f-e31f23574a6d/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-invite
Create and send an invite to a user
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"id": "r-17bbf36498de4d68a0d4f86c7b62f69f", "currentRating": 90, "maxRating": 100, "calculatedPercentage": 90, "reviewsReceived": 12, "likesReceived": 8, "jobsCompleted": 12, "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}]}}
{"title": "Rating List Response", "type": "object", "x-internal": true, "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object", "properties": {"nextCursor": {"title": "Object-Next-Cursor", "type": "string", "description": "The next cursor value that can be used in the following query.", "x-internal": false}, "items": {"type": "array", "items": {"title": "Rating", "type": "object", "description": "The stored performance ratings of the user in the employment data provider.", "x-internal": false, "x-examples": {"Example": {"id": "r-17bbf36498de4d68a0d4f86c7b62f69f", "currentRating": 90, "maxRating": 100, "calculatedPercentage": 90, "reviewsReceived": 12, "likesReceived": 8, "jobsCompleted": 12, "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}}, "x-tags": ["Ratings"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "currentRating": {"type": ["number", "null"], "description": "Current rating"}, "maxRating": {"type": ["number", "null"], "description": "Maximum possible rating"}, "calculatedPercentage": {"type": ["number", "null"], "description": "Current rating expressed as percentage, calculated by currentRating/maxRating x 100"}, "reviewsReceived": {"type": ["number", "null"], "description": "Number of reviews the employee received, which is the basis for the current rating"}, "likesReceived": {"type": ["number", "null"], "description": "Recommendations or kudos received"}, "jobsCompleted": {"type": ["number", "null"], "description": "Jobs actually completed in the employment platform"}, "metadata": {"title": "Reference Metadata", "type": "object", "description": "Metadata related to account-specific data", "x-internal": true, "properties": {"createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "accountId": {"type": "string", "description": "The accountId of this object"}, "sourceId": {"type": "string", "description": "The ACCOUNT or ARCHIVE ID associated with this object"}, "sourceType": {"type": "string", "enum": ["ACCOUNT", "UPLOAD", "ARCHIVE"], "description": "Indicates whether the source associated with this object is either ACCOUNT or ARCHIVE type"}, "userId": {"type": "string", "description": "The user ID associated with this object"}, "providerId": {"type": "string", "description": "The provider ID associated with this object"}}, "required": ["createdAt", "sourceId", "sourceType", "userId", "providerId"]}}, "required": ["id", "metadata"]}}}}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/77f58cfa-b2da-41e9-900f-ccab6c3b2021/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-ratings
Get the user's ratings from employment data sources.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "r-17bbf36498de4d68a0d4f86c7b62f69f", "currentRating": 90, "maxRating": 100, "calculatedPercentage": 90, "reviewsReceived": 12, "likesReceived": 8, "jobsCompleted": 12, "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}}
{"title": "Rating Get Response", "type": "object", "x-internal": true, "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "Rating", "type": "object", "description": "The stored performance ratings of the user in the employment data provider.", "x-internal": false, "x-examples": {"Example": {"id": "r-17bbf36498de4d68a0d4f86c7b62f69f", "currentRating": 90, "maxRating": 100, "calculatedPercentage": 90, "reviewsReceived": 12, "likesReceived": 8, "jobsCompleted": 12, "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}}, "x-tags": ["Ratings"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "currentRating": {"type": ["number", "null"], "description": "Current rating"}, "maxRating": {"type": ["number", "null"], "description": "Maximum possible rating"}, "calculatedPercentage": {"type": ["number", "null"], "description": "Current rating expressed as percentage, calculated by currentRating/maxRating x 100"}, "reviewsReceived": {"type": ["number", "null"], "description": "Number of reviews the employee received, which is the basis for the current rating"}, "likesReceived": {"type": ["number", "null"], "description": "Recommendations or kudos received"}, "jobsCompleted": {"type": ["number", "null"], "description": "Jobs actually completed in the employment platform"}, "metadata": {"title": "Reference Metadata", "type": "object", "description": "Metadata related to account-specific data", "x-internal": true, "properties": {"createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "accountId": {"type": "string", "description": "The accountId of this object"}, "sourceId": {"type": "string", "description": "The ACCOUNT or ARCHIVE ID associated with this object"}, "sourceType": {"type": "string", "enum": ["ACCOUNT", "UPLOAD", "ARCHIVE"], "description": "Indicates whether the source associated with this object is either ACCOUNT or ARCHIVE type"}, "userId": {"type": "string", "description": "The user ID associated with this object"}, "providerId": {"type": "string", "description": "The provider ID associated with this object"}}, "required": ["createdAt", "sourceId", "sourceType", "userId", "providerId"]}}, "required": ["id", "metadata"]}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}