openapi: 3.2.0 info: title: Hostfully Service Providers API license: name: Apache 2.0 url: https://www.hostfully.com/ version: v3.0.1 servers: - url: https://sandbox-api.hostfully.com security: - JWT-Authentication: [] - Agency-API-key: [] tags: - name: Service Providers paths: /api/v3.3/service-providers/{serviceProviderUid}: get: tags: - Service Providers summary: Get service provider description: Retrieves details of a specific service provider operationId: getOne_1 parameters: - name: serviceProviderUid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ServiceProviderApiResponseWrapper' put: tags: - Service Providers summary: Update service provider description: Modifies an existing service provider's details operationId: put_1 parameters: - name: serviceProviderUid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProviderUpdatingApi3Dto' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ServiceProviderApiResponseWrapper' delete: tags: - Service Providers summary: Delete service provider description: Removes a service provider from an agency operationId: delete_1 parameters: - name: serviceProviderUid in: path required: true schema: type: string responses: '200': description: OK /api/v3.3/service-providers: get: tags: - Service Providers summary: List service providers description: Retrieves all service providers for an agency operationId: getAll_2 parameters: - name: agencyUid in: query required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ServiceProvidersApiResponseWrapper' post: tags: - Service Providers summary: Create service provider description: Adds a new service provider to an agency operationId: post_2 requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProviderAddingApi3Dto' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ServiceProviderApiResponseWrapper' components: schemas: ServiceProviderAddingApi3Dto: required: - agencyUid - firstName - lastName - type type: object properties: agencyUid: type: string type: type: string enum: - CLEANER - GREETER - HANDYMAN - LANDSCAPE - CONTRACTOR - OTHER - HOST firstName: maxLength: 255 minLength: 0 type: string lastName: maxLength: 255 minLength: 0 type: string companyName: type: string email: type: string phoneNumber: type: string imageUrl: type: string address: type: string city: type: string zipCode: type: string state: type: string countryCode: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AG - AN - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BR - BN - BG - BF - BI - BQ - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - YT - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FJ - FI - FK - FO - FR - GF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GU - GT - GN - GW - GY - GP - HT - VA - HN - HK - HL - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LC - LS - LR - LY - LI - LT - LU - MO - MQ - MK - MG - MW - MY - MV - ML - MT - MH - MR - MU - MX - FM - MD - MC - MN - MS - MA - MZ - MM - ME - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - 'NO' - OM - PK - PW - PA - PG - PS - PY - PE - PF - PH - PL - PN - PT - PR - QA - RO - RU - RW - KN - WS - RE - PM - SH - ST - SM - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - ES - LK - SR - SJ - SZ - SE - CH - SY - TC - TW - TJ - TZ - TH - TG - TO - TT - TN - TR - TM - TV - UG - UA - AE - GB - JE - IM - US - UY - UZ - VC - VU - VE - VN - VG - VI - WF - EH - YE - YU - ZM - ZW currency: type: string enum: - USD - EUR - GBP - CAD - JPY - INR - MYR - AUD - KES - MXN - HKD - NZD - CHF - BRL - CLP - COP - PEN - ARS - UYU - VEF - CNY - THB - KRW - IDR - SGD - TWD - AED - ZAR - CZK - DKK - DOP - SEK - BGN - ILS - NOK - RON - RUB - PHP - VND - HUF - IKR - PLN - PYG - TRY - GTQ - VUV - JOD - SAR - EGP - TTD - MAD - CVE - BBD - AWG - BHD - NONE Api3ResponseMetadata: type: object properties: count: type: integer format: int32 totalCount: type: integer format: int32 ServiceProviderApiResponseWrapper: type: object properties: serviceProvider: $ref: '#/components/schemas/ServiceProviderApi3Dto' ServiceProvidersApiResponseWrapper: type: object properties: serviceProviders: type: array items: $ref: '#/components/schemas/ServiceProviderApi3Dto' _metadata: $ref: '#/components/schemas/Api3ResponseMetadata' ServiceProviderUpdatingApi3Dto: type: object properties: agencyUid: type: string type: type: string enum: - CLEANER - GREETER - HANDYMAN - LANDSCAPE - CONTRACTOR - OTHER - HOST firstName: type: string lastName: type: string companyName: type: string email: type: string phoneNumber: type: string imageUrl: type: string address: type: string city: type: string zipCode: type: string state: type: string countryCode: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AG - AN - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BR - BN - BG - BF - BI - BQ - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - YT - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FJ - FI - FK - FO - FR - GF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GU - GT - GN - GW - GY - GP - HT - VA - HN - HK - HL - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LC - LS - LR - LY - LI - LT - LU - MO - MQ - MK - MG - MW - MY - MV - ML - MT - MH - MR - MU - MX - FM - MD - MC - MN - MS - MA - MZ - MM - ME - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - 'NO' - OM - PK - PW - PA - PG - PS - PY - PE - PF - PH - PL - PN - PT - PR - QA - RO - RU - RW - KN - WS - RE - PM - SH - ST - SM - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - ES - LK - SR - SJ - SZ - SE - CH - SY - TC - TW - TJ - TZ - TH - TG - TO - TT - TN - TR - TM - TV - UG - UA - AE - GB - JE - IM - US - UY - UZ - VC - VU - VE - VN - VG - VI - WF - EH - YE - YU - ZM - ZW currency: type: string enum: - USD - EUR - GBP - CAD - JPY - INR - MYR - AUD - KES - MXN - HKD - NZD - CHF - BRL - CLP - COP - PEN - ARS - UYU - VEF - CNY - THB - KRW - IDR - SGD - TWD - AED - ZAR - CZK - DKK - DOP - SEK - BGN - ILS - NOK - RON - RUB - PHP - VND - HUF - IKR - PLN - PYG - TRY - GTQ - VUV - JOD - SAR - EGP - TTD - MAD - CVE - BBD - AWG - BHD - NONE ServiceProviderApi3Dto: type: object properties: uid: type: string type: type: string enum: - CLEANER - GREETER - HANDYMAN - LANDSCAPE - CONTRACTOR - OTHER - HOST firstName: type: string lastName: type: string companyName: type: string email: type: string phoneNumber: type: string imageUrl: type: string address: type: string city: type: string zipCode: type: string state: type: string countryCode: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AG - AN - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BR - BN - BG - BF - BI - BQ - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - YT - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FJ - FI - FK - FO - FR - GF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GU - GT - GN - GW - GY - GP - HT - VA - HN - HK - HL - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LC - LS - LR - LY - LI - LT - LU - MO - MQ - MK - MG - MW - MY - MV - ML - MT - MH - MR - MU - MX - FM - MD - MC - MN - MS - MA - MZ - MM - ME - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - 'NO' - OM - PK - PW - PA - PG - PS - PY - PE - PF - PH - PL - PN - PT - PR - QA - RO - RU - RW - KN - WS - RE - PM - SH - ST - SM - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - ES - LK - SR - SJ - SZ - SE - CH - SY - TC - TW - TJ - TZ - TH - TG - TO - TT - TN - TR - TM - TV - UG - UA - AE - GB - JE - IM - US - UY - UZ - VC - VU - VE - VN - VG - VI - WF - EH - YE - YU - ZM - ZW currency: type: string enum: - USD - EUR - GBP - CAD - JPY - INR - MYR - AUD - KES - MXN - HKD - NZD - CHF - BRL - CLP - COP - PEN - ARS - UYU - VEF - CNY - THB - KRW - IDR - SGD - TWD - AED - ZAR - CZK - DKK - DOP - SEK - BGN - ILS - NOK - RON - RUB - PHP - VND - HUF - IKR - PLN - PYG - TRY - GTQ - VUV - JOD - SAR - EGP - TTD - MAD - CVE - BBD - AWG - BHD - NONE securitySchemes: JWT-Authentication: type: apiKey description: OAuth Access Token name: Authorization in: header Agency-API-key: type: apiKey description: API Key name: X-HOSTFULLY-APIKEY in: header externalDocs: description: Hostfully Documentation url: https://dev.hostfully.com/v3.0/reference x-readme: explorer-enabled: true proxy-enabled: true