Errors
HTTP status codes, and the status field in every response.
Every response body includes a status field. Use the HTTP code to tell success from failure, and status for the details.
| HTTP | status | Meaning |
|---|---|---|
| 200 | ok, no_results, no_material_updates, partial, not_covered | The call succeeded. It may have nothing to return. |
| 400 | invalid_argument or choose_workspace | A parameter isn't valid, or workspace_id is missing and you have more than one workspace. |
| 401 | unauthorized | The key is missing, invalid, or revoked. |
| 403 | not_entitled | Your plan doesn't include the API. |
| 404 | not_found | Nothing exists with that id. |
| 409 | ambiguous | The name matches more than one company or person. |
| 429 | rate_limited | You've hit a rate limit. |
| 503 | unavailable | Drip couldn't complete the request. Try again later. |
Empty results
A call that finds nothing, such as a search with no matches or no new updates since your last check, still returns HTTP 200. Check status to see why it's empty.
400
A parameter value that isn't allowed returns invalid_argument. For example, detail must be headlines, compact, or full:
curl "https://api.joindrip.ai/v1/workspaces/$WORKSPACE_ID/updates?since=24h&detail=nope" \
-H "Authorization: Bearer $DRIP_API_KEY"If you have more than one workspace and leave out workspace_id, the call returns choose_workspace with a list of your workspaces. See Choosing a workspace.
401
Calls without a key, or with a key that isn't valid, return unauthorized:
curl "https://api.joindrip.ai/v1/workspaces" \
-H "Authorization: Bearer drip_live_invalid"404
An id that doesn't exist returns not_found:
curl "https://api.joindrip.ai/v1/stories/story:0?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $DRIP_API_KEY"409
Looking up a name that matches more than one person or company returns ambiguous, with a candidates list to choose from. Call again with the id of the one you want.
curl "https://api.joindrip.ai/v1/people/resolve?name=Alex&workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $DRIP_API_KEY"429
You've gone over a rate limit. Wait the number of seconds in the Retry-After header, then try again. See Rate limits.