Mock API
Our Mock API gives you the possibility to test out our Unified API without the need for an account.
Base URL
The base URL for all mock API requests is https://mock-api.apideck.com
Using cURL
Just copy paste the following command into your terminal and you should see a mock response
Request
curl --request GET \
--url 'https://mock-api.apideck.com/crm/activities/123' \
--header 'Authorization: Bearer dummy-api-key' \
--header 'x-apideck-app-id: dummy-app-id' \
--header 'x-apideck-consumer-id: dummy-consumer-id' \
--header 'x-apideck-service-id: dummy-service-id'Response
{
"status_code": 200,
"status": "OK",
"service": "zoho-crm",
"resource": "activities",
"operation": "one",
"data": {
"id": "12345",
"downstream_id": "12345",
"activity_datetime": "2021-05-01T12:00:00.000Z",
"duration_seconds": 1800,
"user_id": "12345",
"account_id": "12345",
"contact_id": "12345",
"company_id": "12345",
"opportunity_id": "12345",
"lead_id": "12345",
"owner_id": "12345",
"campaign_id": "12345",
"case_id": "12345",
"asset_id": "12345",
"contract_id": "12345",
"product_id": "12345",
"solution_id": "12345",
"custom_object_id": "12345",
"type": "call",
"title": "Meeting",
"description": "More info about the meeting",
"note": "An internal note about the meeting",
"location": "Space",
"location_address": {
"id": "123",
"type": "primary",
"string": "25 Spring Street, Blackburn, VIC 3130",
"name": "HQ US",
"line1": "Main street",
"line2": "apt #",
"line3": "Suite #",
"line4": "delivery instructions",
"street_number": "25",
"city": "San Francisco",
"state": "CA",
"postal_code": "94104",
"country": "US",
"latitude": "40.759211",
"longitude": "-73.984638",
"county": "Santa Clara",
"contact_name": "Elon Musk",
"salutation": "Mr",
"phone_number": "111-111-1111",
"fax": "122-111-1111",
"email": "elon@musk.com",
"website": "https://elonmusk.com",
"row_version": "1-12345"
},
"all_day_event": false,
"private": true,
"group_event": true,
"event_sub_type": "debrief",
"group_event_type": "Proposed",
"child": false,
"archived": false,
"deleted": false,
"show_as": "free",
"done": false,
"start_datetime": "2021-05-01T12:00:00.000Z",
"end_datetime": "2021-05-01T12:30:00.000Z",
"duration_minutes": 30,
"activity_date": "2021-05-01",
"end_date": "2021-05-01",
"recurrent": false,
"reminder_datetime": "2021-05-01T17:00:00.000Z",
"reminder_set": false,
"video_conference_url": "https://us02web.zoom.us/j/88120759396",
"video_conference_id": "zoom:88120759396",
"custom_fields": [
{
"id": "2389328923893298",
"name": "employee_level",
"description": "Employee Level",
"value": "Uses Salesforce and Marketo"
}
],
"attendees": [
{
"id": "12345",
"name": "Elon Musk",
"first_name": "Elon",
"middle_name": "D.",
"last_name": "Musk",
"prefix": "Mr.",
"suffix": "PhD",
"email_address": "elon@musk.com",
"is_organizer": true,
"status": "accepted",
"user_id": "12345",
"contact_id": "12345",
"updated_at": "2017-08-12T20:43:21.291Z",
"created_at": "2017-08-12T20:43:21.291Z"
}
],
"updated_by": "12345",
"created_by": "12345",
"updated_at": "2020-09-30T07:43:32.000Z",
"created_at": "2020-09-30T07:43:32.000Z"
}
}Using an SDK
If you want to use one of our SDKs, you can pass the mock url as a basePath argument when initializing the SDK configuration.
Node.js example
const { Apideck } = require('@apideck/node')
const apideck = new Apideck({
basePath: 'https://mock-api.apideck.com', // <===== Add mock server url here
apiKey: '<insert-api-key-here>',
appId: '<insert-application-id-here>',
consumerId: '<insert-consumer-id-here>'
})
const { crm } = apideck
const response = await crm.contactsAll({ limit: 10 })