Oracle Fusion Cloud Applications Contacts API

openapi: 3.1.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Contacts API
  description: REST APIs for Oracle Fusion Cloud Applications Common features, providing access to shared services such as attachments, flexfields, lookup types, roles, users, security, scheduled processes, announcements, and approval workflows used across all Fusion Cloud application pillars.
  version: 11.13.18.05
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/corporate/contracts/cloud-services/
  termsOfService: https://www.oracle.com/corporate/contracts/cloud-services/
servers:
- url: https://{instance}.oraclecloud.com
  description: Oracle Fusion Cloud Instance
  variables:
    instance:
      default: servername
      description: Your Oracle Cloud instance identifier
security:
- bearerAuth: []
tags:
- name: Contacts
  description: Manage contact records associated with accounts
paths:
  /crmRestApi/resources/11.13.18.05/contacts:
    get:
      operationId: listContacts
      summary: Oracle Fusion Cloud Applications List contacts
      description: Retrieve contact records associated with customer accounts.
      tags:
      - Contacts
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/finder'
      responses:
        '200':
          description: Contacts retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
                  count:
                    type: integer
                  hasMore:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createContact
      summary: Oracle Fusion Cloud Applications Create a contact
      description: Create a new contact record.
      tags:
      - Contacts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactCreate'
      responses:
        '201':
          description: Contact created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}:
    get:
      operationId: getContact
      summary: Oracle Fusion Cloud Applications Get a contact
      description: Retrieve a specific contact record.
      tags:
      - Contacts
      parameters:
      - name: PartyNumber
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Contact details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateContact
      summary: Oracle Fusion Cloud Applications Update a contact
      description: Update an existing contact record.
      tags:
      - Contacts
      parameters:
      - name: PartyNumber
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactCreate'
      responses:
        '200':
          description: Contact updated
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ContactCreate:
      type: object
      required:
      - FirstName
      - LastName
      properties:
        FirstName:
          type: string
        LastName:
          type: string
        JobTitle:
          type: string
        EmailAddress:
          type: string
          format: email
        WorkPhoneNumber:
          type: string
        MobilePhoneNumber:
          type: string
        AccountPartyNumber:
          type: string
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        detail:
          type: string
        o:errorCode:
          type: string
    Contact:
      type: object
      properties:
        PartyId:
          type: integer
          description: Party identifier
        PartyNumber:
          type: string
          description: Party number
        FirstName:
          type: string
          description: First name
        LastName:
          type: string
          description: Last name
        FullName:
          type: string
          description: Full name
        JobTitle:
          type: string
          description: Job title
        EmailAddress:
          type: string
          format: email
          description: Email address
        WorkPhoneNumber:
          type: string
          description: Work phone number
        MobilePhoneNumber:
          type: string
          description: Mobile phone number
        AccountName:
          type: string
          description: Associated account name
        AccountPartyNumber:
          type: string
          description: Associated account party number
        OwnerName:
          type: string
          description: Contact owner name
        CreationDate:
          type: string
          format: date-time
  responses:
    NotFound:
      description: The requested resource was not found
    BadRequest:
      description: Invalid request parameters or payload
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication credentials are missing or invalid
  parameters:
    q:
      name: q
      in: query
      required: false
      description: Filter expression using Oracle REST query syntax
      schema:
        type: string
    orderBy:
      name: orderBy
      in: query
      required: false
      description: Fields to sort by with optional :asc or :desc direction
      schema:
        type: string
    offset:
      name: offset
      in: query
      required: false
      description: Number of items to skip
      schema:
        type: integer
        default: 0
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated list of fields to return
      schema:
        type: string
    limit:
      name: limit
      in: query
      required: false
      description: Maximum number of items to return (default 25, max 500)
      schema:
        type: integer
        default: 25
        maximum: 500
    finder:
      name: finder
      in: query
      required: false
      description: Named finder in format FinderName;param1=value1
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Oracle Fusion Cloud Applications Common Features REST API Documentation
  url: https://docs.oracle.com/en/cloud/saas/applications-common/26a/farca/index.html