API reference
Agent API
Per-business CRUD the platform's agents use to write business information.
Service-to-service endpoints the Keystone agents (website, content, social, listings and the rest) call to read and write a business's records. Each resource mirrors a Business Info section.
46 endpoints in 8 groups.
Business
FAQ
- GET
/api/v1/agent/businesses/{business_id}/faqsList FAQs (agent) - POST
/api/v1/agent/businesses/{business_id}/faqsCreate FAQ (agent) - GET
/api/v1/agent/businesses/{business_id}/faqs/{faq_id}Get FAQ (agent) - PUT
/api/v1/agent/businesses/{business_id}/faqs/{faq_id}Update FAQ (agent) - PATCH
/api/v1/agent/businesses/{business_id}/faqs/{faq_id}Partial update FAQ (agent) - DELETE
/api/v1/agent/businesses/{business_id}/faqs/{faq_id}Delete FAQ (agent)
Jobs
- GET
/api/v1/agent/businesses/{business_id}/job_postingsList job postings (agent) - POST
/api/v1/agent/businesses/{business_id}/job_postingsCreate job posting (agent) - GET
/api/v1/agent/businesses/{business_id}/job_postings/{job_posting_id}Get job posting (agent) - PUT
/api/v1/agent/businesses/{business_id}/job_postings/{job_posting_id}Update job posting (agent) - PATCH
/api/v1/agent/businesses/{business_id}/job_postings/{job_posting_id}Partial update job posting (agent) - DELETE
/api/v1/agent/businesses/{business_id}/job_postings/{job_posting_id}Delete job posting (agent)
Locations
- GET
/api/v1/agent/businesses/{business_id}/locationsList locations (agent) - POST
/api/v1/agent/businesses/{business_id}/locationsCreate location (agent) - GET
/api/v1/agent/businesses/{business_id}/locations/{location_id}Get location (agent) - PUT
/api/v1/agent/businesses/{business_id}/locations/{location_id}Update location (agent) - PATCH
/api/v1/agent/businesses/{business_id}/locations/{location_id}Partial update location (agent) - DELETE
/api/v1/agent/businesses/{business_id}/locations/{location_id}Delete location (agent)
Packages
- GET
/api/v1/agent/businesses/{business_id}/packagesList packages (agent) - POST
/api/v1/agent/businesses/{business_id}/packagesCreate package (agent) - GET
/api/v1/agent/businesses/{business_id}/packages/{package_id}Get package (agent) - PUT
/api/v1/agent/businesses/{business_id}/packages/{package_id}Update package (agent) - PATCH
/api/v1/agent/businesses/{business_id}/packages/{package_id}Partial update package (agent) - DELETE
/api/v1/agent/businesses/{business_id}/packages/{package_id}Delete package (agent) - PUT
/api/v1/agent/businesses/{business_id}/packages/{package_id}/service-itemsSet package member service items (agent)
Service items
- GET
/api/v1/agent/businesses/{business_id}/service-itemsList service items (agent) - POST
/api/v1/agent/businesses/{business_id}/service-itemsCreate service item (agent) - GET
/api/v1/agent/businesses/{business_id}/service-items/{item_id}Get service item (agent) - PUT
/api/v1/agent/businesses/{business_id}/service-items/{item_id}Update service item (agent) - PATCH
/api/v1/agent/businesses/{business_id}/service-items/{item_id}Partial update service item (agent) - DELETE
/api/v1/agent/businesses/{business_id}/service-items/{item_id}Delete service item (agent) - PUT
/api/v1/agent/businesses/{business_id}/service-items/{item_id}/servicesSet service item member services (agent)
Services
- GET
/api/v1/agent/businesses/{business_id}/servicesList services (agent) - POST
/api/v1/agent/businesses/{business_id}/servicesCreate service (agent) - GET
/api/v1/agent/businesses/{business_id}/services/{service_id}Get service (agent) - PUT
/api/v1/agent/businesses/{business_id}/services/{service_id}Update service (agent) - PATCH
/api/v1/agent/businesses/{business_id}/services/{service_id}Partial update service (agent) - DELETE
/api/v1/agent/businesses/{business_id}/services/{service_id}Delete service (agent)
Team
- GET
/api/v1/agent/businesses/{business_id}/team_membersList team members (agent) - POST
/api/v1/agent/businesses/{business_id}/team_membersCreate team member (agent) - GET
/api/v1/agent/businesses/{business_id}/team_members/{team_member_id}Get team member (agent) - PUT
/api/v1/agent/businesses/{business_id}/team_members/{team_member_id}Update team member (agent) - PATCH
/api/v1/agent/businesses/{business_id}/team_members/{team_member_id}Partial update team member (agent) - DELETE
/api/v1/agent/businesses/{business_id}/team_members/{team_member_id}Delete team member (agent)