Skip to main content

User Status With Email

Check whether a specific user, identified by both ID and email, belongs to your IB.

Endpoint​

GET https://base-url/api/ib/user-status-with-email

Authentication​

Requires Authorization: Bearer <YOUR_API_KEY> — see Authentication.


Request​

Query parameters​

ParameterTypeRequiredDescription
user_idstring (UUID)✅ YesThe ID of the user to look up
emailstring (email)✅ YesThe email of the user to look up

Example request​

GET /api/ib/user-status-with-email?user_id=a1b2c3d4-0000-0000-0000-000000000000&email=user@example.com
Authorization: Bearer YOUR_API_KEY

Response​

200 — User is under your IB​

{
"is_under_ib": true,
"date_joined": "2026-06-24T08:30:00.000Z"
}

200 — User is not under your IB​

{
"is_under_ib": false,
"date_joined": null
}

Response fields​

FieldTypeDescription
is_under_ibbooleantrue if the user belongs to your IB; false otherwise
date_joinedstring | nullISO 8601 UTC timestamp of when the user joined under your IB. null when is_under_ib is false

Errors​

StatusBodyCause
400 Bad Request{"error":"Invalid user_id format"}user_id is missing or not a valid UUID
400 Bad Request{"error":"Invalid email format"}email is missing or not a valid email address
401 Unauthorized{"error":"Unauthorized"}API key is missing, invalid, or non-Partner
429 Too Many Requests{"error":"Too many failed lookups. Please try again later."}Rate limit exceeded

See the Error Codes reference for full details.


Notes​

  • Unlike User Status, this endpoint requires both user_id and email to match — it returns is_under_ib: false if either doesn't match a user under your IB.
  • No additional user data is returned — only IB membership status and join date.
  • This endpoint is scoped solely to checking membership within your Partner account, it cannot query other partners or users.
  • A 200 response with is_under_ib: false means the user exists but is not under your IB (or the email doesn't match) — it is not an error condition.