CRM cards
Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.
Endpoints 6
Cards
- GETGet all cards
/crm/v3/extensions/cards/:appIdReturns a list of cards for a given app. - POSTCreate a new card
/crm/v3/extensions/cards/:appIdDefines a new card that will become active on an account when this app is installed. - GETGet a card.
/crm/v3/extensions/cards/:appId/:cardIdReturns the definition for a card with the given ID. - DELETEDelete a card
/crm/v3/extensions/cards/:appId/:cardIdPermanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be… - PATCHUpdate a card
/crm/v3/extensions/cards/:appId/:cardIdUpdate a card definition with new details.
SampleResponse
- GETGet sample card detail response
/crm/v3/extensions/cards/sample-responseReturns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in…
API details
- Base URL
https://api.hubapi.com- Authentication
- An API key in the hapikey query parameter
- Operations
- 6 operations on 3 pathsGET 3POST 1PATCH 1DELETE 1
- Main resources
- Cards 5SampleResponse 1
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
v3 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the CRM cards in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the CRM cards collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the hapikey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get all cards” (GET /crm/v3/extensions/cards/:appId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the CRM cards?
Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration,… It is listed under Other and has 6 endpoints.
Who publishes the CRM cards?
It is listed from HubSpot's public API description (an OpenAPI document), not published by HubSpot on Swastik Codes. Anyone who controls hubapi.com can claim the profile by adding a DNS TXT record.
What is the base URL of the CRM cards?
Requests go to https://api.hubapi.com. Endpoint paths are added to this base URL.
How do I authenticate with the CRM cards?
With an API key in the hapikey query parameter.
How many endpoints does the CRM cards have?
6 operations on 3 paths (3 GET, 1 POST, 1 PATCH, 1 DELETE). The largest groups are Cards, SampleResponse.
Is forking the CRM cards free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.