# Blackbaud Users API

**Canonical:** https://apis.io/apis/blackbaud/blackbaud-users-api/  
**Provider:** Blackbaud — https://apis.io/providers/blackbaud/  
**Base URL:** https://api.sky.blackbaud.com/afe-edaca  
**Documentation:** https://developer.sky.blackbaud.com/api-details#api=afe-edaca

Blackbaud Users API is one of 313 APIs that [Blackbaud](https://apis.io/providers/blackbaud/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 84 JSON Schema definitions. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 84 JSON Schemas.

The Users API from Blackbaud — 42 operation(s) for users.

## Operations (56)

| Method | Path | Summary |
|---|---|---|
| PATCH | `/v1/users/bbid/connect` | User BBID (Connect) (PREVIEW) |
| PATCH | `/v1/users/bbid/disconnect` | User BBID (Disconnect) (PREVIEW) |
| POST | `/v1/users/search` | User (Search) (PREVIEW) |
| GET | `/users` | Users all |
| GET | `/users/{id}` | User by id |
| POST | `/v1/users` | User create |
| PATCH | `/v1/users` | User update |
| GET | `/v1/users` | Users by role(s) |
| GET | `/v1/users/addresstypes` | Users address types |
| GET | `/v1/users/audit` | Users audit by role ID |
| GET | `/v1/users/bbidstatus` | Users BBID status by role(s) |
| GET | `/v1/users/changed` | Users changed by base role(s) |
| GET | `/v1/users/customfields` | Users custom fields list by base role(s) |
| GET | `/v1/users/emergencycontacts/changed` | Users emergency contact changes |
| GET | `/v1/users/employment` | Users employment by role(s) |
| POST | `/v1/users/enroll` | Users enrollment create |
| GET | `/v1/users/enrollments` | Users enrollments by year |
| GET | `/v1/users/extended` | Users extended by role(s) |
| GET | `/v1/users/extended/{user_id}` | Users extended by user |
| GET | `/v1/users/gendertypes` | Users gender types |
| GET | `/v1/users/me` | Users Get Me |
| GET | `/v1/users/phonetypes` | Users phone types |
| GET | `/v1/users/{parent_id}/students` | Users Children of Parent |
| GET | `/v1/users/{user_id}` | User by ID |
| POST | `/v1/users/{user_id}/addresses` | Users address create |
| GET | `/v1/users/{user_id}/addresses` | Users addresses by user ID |
| POST | `/v1/users/{user_id}/addresses/share` | Users address create - shared |
| PATCH | `/v1/users/{user_id}/addresses/{address_id}` | Users address update |
| DELETE | `/v1/users/{user_id}/addresses/{address_id}/{address_type_id}` | Users address delete |
| POST | `/v1/users/{user_id}/customfields` | Users custom fields create |
| GET | `/v1/users/{user_id}/customfields` | Users custom fields single |
| PATCH | `/v1/users/{user_id}/customfields` | Users custom fields update |
| POST | `/v1/users/{user_id}/customfields/list` | Users custom fields list create |
| PATCH | `/v1/users/{user_id}/customfields/list` | Users custom fields list update |
| GET | `/v1/users/{user_id}/education` | Users education by user |
| POST | `/v1/users/{user_id}/education` | Users education create |
| DELETE | `/v1/users/{user_id}/education/{education_id}` | Users education delete |
| PATCH | `/v1/users/{user_id}/education/{education_id}` | Users education update |
| GET | `/v1/users/{user_id}/emergencycontacts` | Users emergency contacts by user ID |
| POST | `/v1/users/{user_id}/emergencycontacts/nonuser` | Users emergency contact non-user create |
| POST | `/v1/users/{user_id}/emergencycontacts/user` | Users emergency contact user create |
| GET | `/v1/users/{user_id}/employment` | Users employment by user ID |
| PATCH | `/v1/users/{user_id}/employment` | Users employment update |
| POST | `/v1/users/{user_id}/occupations` | Users occupation create |
| GET | `/v1/users/{user_id}/occupations` | Users occupations by user ID |
| DELETE | `/v1/users/{user_id}/occupations/{occupation_id}` | Users occupation delete |
| PATCH | `/v1/users/{user_id}/occupations/{occupation_id}` | Users occupation update |
| POST | `/v1/users/{user_id}/phones` | Users phone create |
| GET | `/v1/users/{user_id}/phones` | Users phones by user |
| POST | `/v1/users/{user_id}/phones/share` | Users phone create - shared |
| PATCH | `/v1/users/{user_id}/phones/{phone_id}` | Users phone update |
| DELETE | `/v1/users/{user_id}/phones/{phone_id}/{phone_type_id}` | Users phone delete |
| POST | `/v1/users/{user_id}/relationships` | Users relationship create |
| DELETE | `/v1/users/{user_id}/relationships` | Users relationship delete |
| GET | `/v1/users/{user_id}/relationships` | Users relationships by user |
| PATCH | `/v1/users/{user_id}/relationships/{left_user_id}` | Users relationship update |

## Machine-readable artifacts (137)

- **OpenAPI** — https://artifacts.apis.io/blackbaud/openapi/blackbaud-users-api-openapi.yml
- **Documentation** — https://developer.sky.blackbaud.com/api-details#api=57a342f1d7dcde1c28a749fe
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-invoice-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-create-invoice-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-line-item-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-purchase-order-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-credit-memo-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-vendor-detail-schema.json
- **Documentation** — https://developer.sky.blackbaud.com/api-details#api=alt-adnmg
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-revenue-batch-row-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-edit-batch-template-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-batch-template-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-batch-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-business-process-view-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-notification-schema.json
- **Documentation** — https://developer.sky.blackbaud.com/api-details#api=alt-anamg
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-ad-hoc-query-execution-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-save-ad-hoc-query-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-ad-hoc-query-execution-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-save-ad-hoc-query-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-ad-hoc-query-get-definition-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-delete-ad-hoc-query-execution-response-schema.json
- **Documentation** — https://developer.sky.blackbaud.com/api-details#api=alt-conmg
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-constituent-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-individual-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-constituent-summary-profile-view-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-edit-constituent-address-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-constituent-address-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-constituent-address-schema.json
- **Documentation** — https://developer.sky.blackbaud.com/api-details#api=alt-evtmg
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-event-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-event-view-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-event-registrant-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-edit-event-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-event-registration-option-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-event-schema.json
- **Documentation** — https://developer.sky.blackbaud.com/api-details#api=alt-fndmg
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-edit-fundraising-purpose-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-new-fundraising-purpose-schema.json
- **JSONSchema** — https://artifacts.apis.io/blackbaud/json-schema/blackbaud-edit-fundraising-purpose-recipient-schema.json
- …and 97 more, listed in full on the page.

## Other Blackbaud APIs (12)

- [Blackbaud Academics API](https://apis.io/apis/blackbaud/blackbaud-academics-api/)
- [Blackbaud Consent API](https://apis.io/apis/blackbaud/blackbaud-consent-api/)
- [Blackbaud Constituent API](https://apis.io/apis/blackbaud/blackbaud-constituent-api/)
- [Blackbaud Enrichment API](https://apis.io/apis/blackbaud/blackbaud-enrichment-api/)
- [Blackbaud Event API](https://apis.io/apis/blackbaud/blackbaud-event-api/)
- [Blackbaud Payments API](https://apis.io/apis/blackbaud/blackbaud-payments-api/)
- [Blackbaud Prospect API](https://apis.io/apis/blackbaud/blackbaud-prospect-api/)
- [Blackbaud Volunteer API](https://apis.io/apis/blackbaud/blackbaud-volunteer-api/)
- [Blackbaud Academic Sessions API](https://apis.io/apis/blackbaud/blackbaud-academicsessions-api/)
- [Blackbaud Accounts API](https://apis.io/apis/blackbaud/blackbaud-accounts-api/)
- [Blackbaud Actionlocations API](https://apis.io/apis/blackbaud/blackbaud-actionlocations-api/)
- [Blackbaud Actions API](https://apis.io/apis/blackbaud/blackbaud-actions-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/blackbaud/blackbaud-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/blackbaud/.